Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ import * as fileResource from './fileResource';
import { resourceCache } from './cache';
import { initializeDataReader as preloadResource } from './dataReaderInitializer';
import AsyncResourceContent from './AsyncResourceContent';
import { AsyncResourceOptions } from './useAsyncResource';

export {
useAsyncResource,
preloadResource,
fileResource,
resourceCache,
AsyncResourceContent,
AsyncResourceOptions,
}
32 changes: 29 additions & 3 deletions src/useAsyncResource.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ import {
} from './types';
import { initializeDataReader } from './dataReaderInitializer';

export interface AsyncResourceOptions {
suspend?: boolean;
}

/**
* Lazy initializer.
* The only param passed is the api function that will be wrapped.
Expand All @@ -20,6 +24,7 @@ import { initializeDataReader } from './dataReaderInitializer';
*/
export function useAsyncResource<ResponseType, ArgTypes extends unknown[]>(
apiFunction: ApiFn<ResponseType, ArgTypes>,
options?: AsyncResourceOptions
): [LazyDataOrModifiedFn<ResponseType>, UpdaterFn<ArgTypes>];

/**
Expand All @@ -37,6 +42,7 @@ export function useAsyncResource<ResponseType, ArgTypes extends unknown[]>(
export function useAsyncResource<ResponseType>(
apiFunction: ApiFn<ResponseType>,
eagerLoading: never[], // the type of an empty array `[]` is `never[]`
options?: AsyncResourceOptions
): [DataOrModifiedFn<ResponseType>, UpdaterFn];

/**
Expand All @@ -51,14 +57,21 @@ export function useAsyncResource<ResponseType>(
*/
export function useAsyncResource<ResponseType, ArgTypes extends unknown[]>(
apiFunction: ApiFn<ResponseType, ArgTypes>,
...parameters: ArgTypes
...paramsAndOptions: [...ArgTypes, AsyncResourceOptions?]
): [DataOrModifiedFn<ResponseType>, UpdaterFn<ArgTypes>];

// implementation that covers the above overloads
export function useAsyncResource<ResponseType, ArgTypes extends unknown[]>(
apiFunction: ApiFn<ResponseType> | ApiFn<ResponseType, ArgTypes>,
...parameters: ArgTypes
...args: any[]
) {
const lastArg = args[args.length - 1];
const options = (typeof lastArg === 'object' && lastArg !== null && 'suspend' in lastArg)
? (lastArg as AsyncResourceOptions)
: {};
const parameters = options.suspend !== undefined ? args.slice(0, -1) : args;
const shouldSuspend = options.suspend !== false;

// keep the data reader inside a mutable object ref
// always initialize with a lazy data reader, as it can be overwritten by the useMemo immediately
const dataReaderObj = useRef<DataOrModifiedFn<ResponseType> | LazyDataOrModifiedFn<ResponseType>>(() => undefined);
Expand Down Expand Up @@ -96,5 +109,18 @@ export function useAsyncResource<ResponseType, ArgTypes extends unknown[]>(
forceRender(ct => 1 - ct);
}, [apiFunction]);

return [dataReaderObj.current, updaterFn];
if (shouldSuspend) {
return [dataReaderObj.current, updaterFn];
}

const safeDataReader: LazyDataOrModifiedFn<ResponseType> = (modifier) => {
try {
return dataReaderObj.current(modifier as any);
} catch (e) {
if (e && typeof (e as any).then === 'function') return undefined;
throw e;
}
};

return [safeDataReader, updaterFn];
}