Interface: QueryCollectionMeta

Defined in: packages/query-db-collection/src/global.ts:30

Base interface for Query Collection meta properties. Users can extend this interface to add their own custom properties while preserving loadSubsetOptions.

Example

typescript

declare module "@tanstack/query-db-collection" {
  interface QueryCollectionMeta {
    myCustomProperty: string
    userId?: number
  }
}

declare module "@tanstack/query-db-collection" {
  interface QueryCollectionMeta {
    myCustomProperty: string
    userId?: number
  }
}

Extends

Record<string, unknown>

Indexable

[key: string]: unknown

[key: string]: unknown

Properties

loadSubsetOptions?

optional loadSubsetOptions: LoadSubsetOptions;

optional loadSubsetOptions: LoadSubsetOptions;

Defined in: packages/query-db-collection/src/global.ts:31