Skip to content

@ls-stack/react-utils / useActionFn

useActionFn

Functions

useActionFn()

ts
function useActionFn<A, T>(action): object;

Defined in: packages/react-utils/src/useActionFn.ts:5

Type Parameters

A

A extends unknown[]

T

T

Parameters

action

(...params) => T

Returns

object

call()
ts
call: (...args) => Promise<null | Awaited<T>>;
Parameters
args

...A

Returns

Promise<null | Awaited<T>>

isInProgress
ts
isInProgress: boolean;

useActionFnWithState()

ts
function useActionFnWithState<T, A, R>(action): object;

Defined in: packages/react-utils/src/useActionFn.ts:38

Type Parameters

T

T extends string | number

A

A extends unknown[]

R

R

Parameters

action

(state, ...params) => R

Returns

object

call()
ts
call: (state, ...args) => Promise<false | Awaited<R>>;
Parameters
state

T

args

...A

Returns

Promise<false | Awaited<R>>

isInProgress()
ts
isInProgress: (state) => boolean;
Parameters
state

T

Returns

boolean