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