@playlive/react-query
    Preparing search index...

    Interface UseFetchResult<T>

    Standard hook return shape. Identical to @playlive/react-data/types#UseFetchResult — kept in sync as a structural contract.

    interface UseFetchResult<T> {
        data: T | undefined;
        error: Error | null;
        isFetching: boolean;
        isLoading: boolean;
        isPending: boolean;
        refetch: (options?: HookRefetchOptions) => Promise<void>;
    }

    Type Parameters

    • T

      Concrete data payload returned by the underlying fetcher.

    Index
    data: T | undefined

    Latest resolved data, or undefined until the first success.

    error: Error | null

    Most recent error thrown by the fetcher, or null on success.

    isFetching: boolean

    true whenever a fetch is in flight (initial / poll / refetch).

    isLoading: boolean

    true from mount until the first resolve / reject.

    isPending: boolean

    true while the query has neither resolved data nor a captured error — i.e. we haven't checked/fetched yet. Passed through directly from TanStack Query v5's isPending (status === 'pending'): stays true when enabled is false, and only flips to false once the fetcher succeeds or errors.

    refetch: (options?: HookRefetchOptions) => Promise<void>

    Manually trigger a refetch. Defaults to cancelling any in-flight request first (cancelRefetch: true); pass { cancelRefetch: false } to preserve an in-flight fetch (useful for polling loops that don't want to interrupt a cursor walk).