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

CollectionIndexMetadata.md

83 lines1.8 KB

1---
2id: CollectionIndexMetadata
3title: CollectionIndexMetadata
4---
5​
6# Interface: CollectionIndexMetadata
7​
8Defined in: [packages/db/src/collection/events.ts:70](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L70)
9​
10## Properties
11​
12### expression
13​
14```ts
15expression: BasicExpression;
16```
17​
18Defined in: [packages/db/src/collection/events.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L82)
19​
20***
21​
22### indexId
23​
24```ts
25indexId: number;
26```
27​
28Defined in: [packages/db/src/collection/events.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L80)
29​
30***
31​
32### name?
33​
34```ts
35optional name: string;
36```
37​
38Defined in: [packages/db/src/collection/events.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L81)
39​
40***
41​
42### options?
43​
44```ts
45optional options: CollectionIndexSerializableValue;
46```
47​
48Defined in: [packages/db/src/collection/events.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L84)
49​
50***
51​
52### resolver
53​
54```ts
55resolver: CollectionIndexResolverMetadata;
56```
57​
58Defined in: [packages/db/src/collection/events.ts:83](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L83)
59​
60***
61​
62### signature
63​
64```ts
65signature: string;
66```
67​
68Defined in: [packages/db/src/collection/events.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L79)
69​
70Stable signature derived from expression + serializable options.
71Non-serializable option fields are intentionally omitted.
72​
73***
74​
75### signatureVersion
76​
77```ts
78signatureVersion: 1;
79```
80​
81Defined in: [packages/db/src/collection/events.ts:74](https://github.com/TanStack/db/blob/main/packages/db/src/collection/events.ts#L74)
82​
83Version for the signature serialization contract.