Open History to see the last commit
1---
2id: IndexInterface
3title: IndexInterface
4---
5
6Defined in: [packages/db/src/indexes/base-index.ts:58](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L58)
7
8## Type Parameters
9
10### TKey
11
12`TKey` *extends* `string` \| `number` = `string` \| `number`
13
14## Properties
15
16### add()
17
18```ts
19add: (key, item) => void;
20```
21
22Defined in: [packages/db/src/indexes/base-index.ts:61](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L61)
23
24#### Parameters
25
26##### key
27
28`TKey`
29
30##### item
31
32`any`
33
34#### Returns
35
36`void`
37
38***
39
40### build()
41
42```ts
43build: (entries) => void;
44```
45
46Defined in: [packages/db/src/indexes/base-index.ts:65](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L65)
47
48#### Parameters
49
50##### entries
51
52`Iterable`\<\[`TKey`, `any`\]\>
53
54#### Returns
55
56`void`
57
58***
59
60### canOptimizeRangeFor()?
61
62```ts
63optional canOptimizeRangeFor: (value) => boolean;
64```
65
66Defined in: [packages/db/src/indexes/base-index.ts:109](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L109)
67
68Whether the live values in this index share the predicate operand's
69relational domain. Mixed domains can sort differently in the index and
70WHERE evaluator, which can make a range lookup omit matching rows.
71
72#### Parameters
73
74##### value
75
76`unknown`
77
78#### Returns
79
80`boolean`
81
82***
83
84### clear()
85
86```ts
87clear: () => void;
88```
89
90Defined in: [packages/db/src/indexes/base-index.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L66)
91
92#### Returns
93
94`void`
95
96***
97
98### equalityLookup()
99
100```ts
101equalityLookup: (value) => Set<TKey>;
102```
103
104Defined in: [packages/db/src/indexes/base-index.ts:70](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L70)
105
106#### Parameters
107
108##### value
109
110`any`
111
112#### Returns
113
114`Set`\<`TKey`\>
115
116***
117
118### inArrayLookup()
119
120```ts
121inArrayLookup: (values) => Set<TKey>;
122```
123
124Defined in: [packages/db/src/indexes/base-index.ts:71](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L71)
125
126#### Parameters
127
128##### values
129
130`any`[]
131
132#### Returns
133
134`Set`\<`TKey`\>
135
136***
137
138### lookup()
139
140```ts
141lookup: (operation, value) => Set<TKey>;
142```
143
144Defined in: [packages/db/src/indexes/base-index.ts:68](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L68)
145
146#### Parameters
147
148##### operation
149
150`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
151
152##### value
153
154`any`
155
156#### Returns
157
158`Set`\<`TKey`\>
159
160***
161
162### matchesCompareOptions()
163
164```ts
165matchesCompareOptions: (compareOptions) => boolean;
166```
167
168Defined in: [packages/db/src/indexes/base-index.ts:112](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L112)
169
170#### Parameters
171
172##### compareOptions
173
174`CompareOptions`
175
176#### Returns
177
178`boolean`
179
180***
181
182### matchesDirection()
183
184```ts
185matchesDirection: (direction) => boolean;
186```
187
188Defined in: [packages/db/src/indexes/base-index.ts:113](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L113)
189
190#### Parameters
191
192##### direction
193
194[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md)
195
196#### Returns
197
198`boolean`
199
200***
201
202### matchesField()
203
204```ts
205matchesField: (fieldPath) => boolean;
206```
207
208Defined in: [packages/db/src/indexes/base-index.ts:111](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L111)
209
210#### Parameters
211
212##### fieldPath
213
214`string`[]
215
216#### Returns
217
218`boolean`
219
220***
221
222### rangeQuery()
223
224```ts
225rangeQuery: (options) => Set<TKey>;
226```
227
228Defined in: [packages/db/src/indexes/base-index.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L73)
229
230#### Parameters
231
232##### options
233
234[`BTreeRangeQueryOptions`](BTreeRangeQueryOptions.md)
235
236#### Returns
237
238`Set`\<`TKey`\>
239
240***
241
242### rangeQueryReversed()
243
244```ts
245rangeQueryReversed: (options) => Set<TKey>;
246```
247
248Defined in: [packages/db/src/indexes/base-index.ts:74](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L74)
249
250#### Parameters
251
252##### options
253
254[`BTreeRangeQueryOptions`](BTreeRangeQueryOptions.md)
255
256#### Returns
257
258`Set`\<`TKey`\>
259
260***
261
262### remove()
263
264```ts
265remove: (key, item) => void;
266```
267
268Defined in: [packages/db/src/indexes/base-index.ts:62](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L62)
269
270#### Parameters
271
272##### key
273
274`TKey`
275
276##### item
277
278`any`
279
280#### Returns
281
282`void`
283
284***
285
286### supports()
287
288```ts
289supports: (operation) => boolean;
290```
291
292Defined in: [packages/db/src/indexes/base-index.ts:93](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L93)
293
294#### Parameters
295
296##### operation
297
298`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
299
300#### Returns
301
302`boolean`
303
304***
305
306### take()
307
308```ts
309take: (n, from, filterFn?) => TKey[];
310```
311
312Defined in: [packages/db/src/indexes/base-index.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L76)
313
314#### Parameters
315
316##### n
317
318`number`
319
320##### from
321
322`unknown`
323
324##### filterFn?
325
326(`key`) => `boolean`
327
328#### Returns
329
330`TKey`[]
331
332***
333
334### takeFromStart()
335
336```ts
337takeFromStart: (n, filterFn?) => TKey[];
338```
339
340Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L81)
341
342#### Parameters
343
344##### n
345
346`number`
347
348##### filterFn?
349
350(`key`) => `boolean`
351
352#### Returns
353
354`TKey`[]
355
356***
357
358### takeReversed()
359
360```ts
361takeReversed: (n, from, filterFn?) => TKey[];
362```
363
364Defined in: [packages/db/src/indexes/base-index.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L82)
365
366#### Parameters
367
368##### n
369
370`number`
371
372##### from
373
374`unknown`
375
376##### filterFn?
377
378(`key`) => `boolean`
379
380#### Returns
381
382`TKey`[]
383
384***
385
386### takeReversedFromEnd()
387
388```ts
389takeReversedFromEnd: (n, filterFn?) => TKey[];
390```
391
392Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L87)
393
394#### Parameters
395
396##### n
397
398`number`
399
400##### filterFn?
401
402(`key`) => `boolean`
403
404#### Returns
405
406`TKey`[]
407
408***
409
410### update()
411
412```ts
413update: (key, oldItem, newItem) => void;
414```
415
416Defined in: [packages/db/src/indexes/base-index.ts:63](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L63)
417
418#### Parameters
419
420##### key
421
422`TKey`
423
424##### oldItem
425
426`any`
427
428##### newItem
429
430`any`
431
432#### Returns
433
434`void`
435
436## Accessors
437
438### keyCount
439
440#### Get Signature
441
442```ts
443get keyCount(): number;
444```
445
446Defined in: [packages/db/src/indexes/base-index.ts:92](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L92)
447
448##### Returns
449
450`number`
451
452***
453
454### supportsRangeOptimization
455
456#### Get Signature
457
458```ts
459get supportsRangeOptimization(): boolean;
460```
461
462Defined in: [packages/db/src/indexes/base-index.ts:102](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L102)
463
464Whether range lookups (gt/gte/lt/lte) on this index can be trusted to
465return every matching key. Range traversal relies on the index ordering, so
466it is unsafe when the index uses a custom comparator, whose order may not
467match the WHERE evaluator's relational operators. Callers must fall back to
468a full scan when this is `false`.
469
470##### Returns
471
472`boolean`