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

QueryCollectionMeta.md

43 lines911 Bytes

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