react-query/lib/persistQueryClient/persist.d.ts

Hooks for managing, caching and syncing asynchronous and remote data in React

import { QueryClient, DehydratedState, DehydrateOptions, HydrateOptions } from '../core';
import { Promisable } from 'type-fest';
export interface Persister {
    persistClient(persistClient: PersistedClient): Promisable<void>;
    restoreClient(): Promisable<PersistedClient | undefined>;
    removeClient(): Promisable<void>;
}
export interface PersistedClient {
    timestamp: number;
    buster: string;
    clientState: DehydratedState;
}
export interface PersistQueryClienRootOptions {
    /** The QueryClient to persist */
    queryClient: QueryClient;
    /** The Persister interface for storing and restoring the cache
     * to/from a persisted location */
    persister: Persister;
    /** A unique string that can be used to forcefully
     * invalidate existing caches if they do not share the same buster string */
    buster?: string;
}
export interface PersistedQueryClientRestoreOptions extends PersistQueryClienRootOptions {
    /** The max-allowed age of the cache in milliseconds.
     * If a persisted cache is found that is older than this
     * time, it will be discarded */
    maxAge?: number;
    /** The options passed to the hydrate function */
    hydrateOptions?: HydrateOptions;
}
export interface PersistedQueryClientSaveOptions extends PersistQueryClienRootOptions {
    /** The options passed to the dehydrate function */
    dehydrateOptions?: DehydrateOptions;
}
export interface PersistQueryClientOptions extends PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, PersistQueryClienRootOptions {
}
/**
 * Restores persisted data to the QueryCache
 *  - data obtained from persister.restoreClient
 *  - data is hydrated using hydrateOptions
 * If data is expired, busted, empty, or throws, it runs persister.removeClient
 */
export declare function persistQueryClientRestore({ queryClient, persister, maxAge, buster, hydrateOptions, }: PersistedQueryClientRestoreOptions): Promise<void>;
/**
 * Persists data from the QueryCache
 *  - data dehydrated using dehydrateOptions
 *  - data is persisted using persister.persistClient
 */
export declare function persistQueryClientSave({ queryClient, persister, buster, dehydrateOptions, }: PersistedQueryClientSaveOptions): Promise<void>;
/**
 * Subscribe to QueryCache and MutationCache updates (for persisting)
 * @returns an unsubscribe function (to discontinue monitoring)
 */
export declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOptions): () => void;
/**
 * Restores persisted data to QueryCache and persists further changes.
 */
export declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];