Skip to content

QueryCollectionMeta.md

Latest commit

 

History

History
43 lines (30 loc) · 901 Bytes

QueryCollectionMeta.md

File metadata and controls

43 lines (30 loc) · 901 Bytes
id QueryCollectionMeta
title QueryCollectionMeta

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

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

Extends

  • Record<string, unknown>

Indexable

[key: string]: unknown

Properties

loadSubsetOptions

loadSubsetOptions: LoadSubsetOptions;

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