Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

QueryCollectionMeta.md

41 lines877 Bytes

1---
2id: QueryCollectionMeta
3title: QueryCollectionMeta
4---
5​
6Defined in: [packages/query-db-collection/src/global.ts:30](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/global.ts#L30)
7​
8Base interface for Query Collection meta properties.
9Users can extend this interface to add their own custom properties while
10preserving loadSubsetOptions.
11​
12## Example
13​
14```typescript
15declare module "@tanstack/query-db-collection" {
16 interface QueryCollectionMeta {
17 myCustomProperty: string
18 userId?: number
19 }
21```
22​
23## Extends
24​
25- `Record`\<`string`, `unknown`\>
26​
27## Indexable
28​
29```ts
30[key: string]: unknown
31```
32​
33## Properties
34​
35### loadSubsetOptions?
36​
37```ts
38optional loadSubsetOptions: LoadSubsetOptions;
39```
40​
41Defined in: [packages/query-db-collection/src/global.ts:31](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/global.ts#L31)