@wpkernel/ui v0.12.1-beta.3

---

@wpkernel/ui / UseActionResult

Interface: UseActionResult<TInput, TResult>

The result of the useAction hook.

Extends

• UseActionState<TResult>

Type Parameters

TInput

TInput

TResult

TResult

Properties

cancel()

cancel: () => void;

A function to cancel all in-flight requests.

Returns

void

---

inFlight

inFlight: number;

The number of in-flight requests.

Inherited from

UseActionState.inFlight

---

reset()

reset: () => void;

A function to reset the state of the hook.

Returns

void

---

run()

run: (input) => Promise<TResult>;

A function to run the action.

Parameters

input

TInput

The input to the action.

Returns

Promise<TResult>

A promise that resolves with the result of the action.

---

status

status: "idle" | "running" | "success" | "error";

The status of the action.

Inherited from

UseActionState.status

---

error?

optional error: WPKernelError;

The error, if the action failed.

Inherited from

UseActionState.error

---

result?

optional result: TResult;

The result of the action.

Inherited from

UseActionState.result