@mittwald/react-use-promise
Version:
Simple and declarative use of Promises in your React components. Observe their state and refresh them in various advanced ways.
33 lines (32 loc) • 1.51 kB
TypeScript
import { DurationLikeObject } from "luxon";
import { RemoveTimeout } from "../lib/ConsolidatedTimeout.js";
import { EventualValue } from "../lib/EventualValue.js";
import { ObservableValue } from "../observable-value/ObservableValue.js";
import { ResourceLoader, AsyncResourceState, OnRefreshHandler, UseWatchResourceOptions, UseWatchResourceResult } from "./types.js";
export declare class AsyncResource<T = unknown> {
readonly loader: ResourceLoader<T>;
private loaderPromise;
suspensePromise: Promise<void> | undefined;
private resolveSuspensePromise;
private loaderPromiseVersion;
private autoRefreshTimeout;
readonly value: ObservableValue<EventualValue<T>>;
readonly valueWithCache: ObservableValue<EventualValue<T>>;
readonly error: ObservableValue<EventualValue<unknown>>;
syncValue: EventualValue<T>;
syncError: EventualValue<unknown>;
readonly state: ObservableValue<AsyncResourceState>;
private readonly onRefreshListeners;
static voidInstance: AsyncResource<undefined>;
constructor(loader: ResourceLoader<T>);
refresh(): void;
onRefresh(handler: OnRefreshHandler): () => void;
addTTL(ttl: DurationLikeObject): RemoveTimeout;
load(): void;
private resetPromises;
isMatchingError(error: true | unknown): boolean;
private handleLoading;
private handleAsyncLoading;
use<TOptions extends UseWatchResourceOptions>(options?: TOptions): UseWatchResourceResult<T, TOptions>;
watchState(): AsyncResourceState;
}