Interface InvalidateQueryFilters<TPageData>

interface InvalidateQueryFilters {
    exact?: boolean;
    fetchStatus?: FetchStatus;
    predicate?: ((query) => boolean);
    queryKey?: QueryKey;
    refetchPage?: ((lastPage, index, allPages) => boolean);
    refetchType?: "none" | QueryTypeFilter;
    stale?: boolean;
    type?: QueryTypeFilter;
}

Type Parameters

  • TPageData = unknown

Hierarchy

Properties

exact?: boolean

Match query key exactly

fetchStatus?: FetchStatus

Include queries matching their fetchStatus

predicate?: ((query) => boolean)

Type declaration

    • (query): boolean
    • Include queries matching this predicate function

      Parameters

      Returns boolean

queryKey?: QueryKey

Include queries matching this query key

refetchPage?: ((lastPage, index, allPages) => boolean)

Type declaration

    • (lastPage, index, allPages): boolean
    • Parameters

      • lastPage: TPageData
      • index: number
      • allPages: TPageData[]

      Returns boolean

refetchType?: "none" | QueryTypeFilter
stale?: boolean

Include or exclude stale queries

Filter to active queries, inactive queries or all queries

Generated using TypeDoc