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

CollectionIndexMetadata.md

81 lines1.7 KB

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