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? fetchStatus? predicate? queryKey? refetchPage? refetchType? stale? type?

Properties

Optional exact

exact?: boolean

Match query key exactly

Optional fetchStatus

fetchStatus?: FetchStatus

Include queries matching their fetchStatus

Optional predicate

predicate?: ((query) => boolean)

Type declaration

    • (query): boolean

    • Include queries matching this predicate function

      Parameters

      Returns boolean

Optional queryKey

queryKey?: QueryKey

Include queries matching this query key

Optional refetchPage

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

Type declaration

    • (lastPage, index, allPages): boolean

    • Parameters

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

      Returns boolean

Optional refetchType

refetchType?: "none" | QueryTypeFilter

Optional stale

stale?: boolean

Include or exclude stale queries

Optional type

type?: QueryTypeFilter

Filter to active queries, inactive queries or all queries

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc