ls-stack utils

Appearance

@ls-stack/react-utils / useAsyncResource / <internal>

<internal> ​

Type Aliases ​

AsyncResult<T> ​

ts
type AsyncResult<T> = AsyncState<T> & object;

Defined in: packages/react-utils/src/useAsyncResource.ts:13

Type declaration ​

isLoading ​
ts
isLoading: boolean;
load() ​
ts
load: () => void;
Returns ​

void

Type Parameters ​

T ​

T

AsyncState<T> ​

ts
type AsyncState<T> = object;

Defined in: packages/react-utils/src/useAsyncResource.ts:7

Type Parameters ​

T ​

T

Properties ​

data ​
ts
data: T;

Defined in: packages/react-utils/src/useAsyncResource.ts:10

error ​
ts
error: null | Error;

Defined in: packages/react-utils/src/useAsyncResource.ts:9

status ​
ts
status: "idle" | "loading" | "refetching" | "success" | "error";

Defined in: packages/react-utils/src/useAsyncResource.ts:8

Options ​

ts
type Options = object;

Defined in: packages/react-utils/src/useAsyncResource.ts:15

Properties ​

asyncFnUsesExternalDeps? ​
ts
optional asyncFnUsesExternalDeps: boolean;

Defined in: packages/react-utils/src/useAsyncResource.ts:17

externalDeps? ​
ts
optional externalDeps: unknown[];

Defined in: packages/react-utils/src/useAsyncResource.ts:18

lazy? ​
ts
optional lazy: boolean;

Defined in: packages/react-utils/src/useAsyncResource.ts:16