Open History to see the last commit
1---
2id: ReverseIndex
3title: ReverseIndex
4---
5
6# Class: ReverseIndex\<TKey\>
7
8Defined in: [packages/db/src/indexes/reverse-index.ts:6](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L6)
9
10## Type Parameters
11
12### TKey
13
14`TKey` *extends* `string` \| `number`
15
16## Implements
17
18- [`IndexInterface`](../interfaces/IndexInterface.md)\<`TKey`\>
19
20## Constructors
21
22### Constructor
23
24```ts
25new ReverseIndex<TKey>(index): ReverseIndex<TKey>;
26```
27
28Defined in: [packages/db/src/indexes/reverse-index.ts:11](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L11)
29
30#### Parameters
31
32##### index
33
34[`IndexInterface`](../interfaces/IndexInterface.md)\<`TKey`\>
35
36#### Returns
37
38`ReverseIndex`\<`TKey`\>
39
40## Accessors
41
42### indexedKeysSet
43
44#### Get Signature
45
46```ts
47get indexedKeysSet(): Set<TKey>;
48```
49
50Defined in: [packages/db/src/indexes/reverse-index.ts:128](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L128)
51
52##### Returns
53
54`Set`\<`TKey`\>
55
56#### Implementation of
57
58[`IndexInterface`](../interfaces/IndexInterface.md).[`indexedKeysSet`](../interfaces/IndexInterface.md#indexedkeysset)
59
60***
61
62### keyCount
63
64#### Get Signature
65
66```ts
67get keyCount(): number;
68```
69
70Defined in: [packages/db/src/indexes/reverse-index.ts:116](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L116)
71
72##### Returns
73
74`number`
75
76#### Implementation of
77
78[`IndexInterface`](../interfaces/IndexInterface.md).[`keyCount`](../interfaces/IndexInterface.md#keycount)
79
80***
81
82### orderedEntriesArray
83
84#### Get Signature
85
86```ts
87get orderedEntriesArray(): [any, Set<TKey>][];
88```
89
90Defined in: [packages/db/src/indexes/reverse-index.ts:62](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L62)
91
92##### Returns
93
94\[`any`, `Set`\<`TKey`\>\][]
95
96#### Implementation of
97
98[`IndexInterface`](../interfaces/IndexInterface.md).[`orderedEntriesArray`](../interfaces/IndexInterface.md#orderedentriesarray)
99
100***
101
102### orderedEntriesArrayReversed
103
104#### Get Signature
105
106```ts
107get orderedEntriesArrayReversed(): [any, Set<TKey>][];
108```
109
110Defined in: [packages/db/src/indexes/reverse-index.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L66)
111
112##### Returns
113
114\[`any`, `Set`\<`TKey`\>\][]
115
116#### Implementation of
117
118[`IndexInterface`](../interfaces/IndexInterface.md).[`orderedEntriesArrayReversed`](../interfaces/IndexInterface.md#orderedentriesarrayreversed)
119
120***
121
122### supportsRangeOptimization
123
124#### Get Signature
125
126```ts
127get supportsRangeOptimization(): boolean;
128```
129
130Defined in: [packages/db/src/indexes/reverse-index.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L76)
131
132Whether range lookups (gt/gte/lt/lte) on this index can be trusted to
133return every matching key. Range traversal relies on the index ordering, so
134it is unsafe when the index uses a custom comparator, whose order may not
135match the WHERE evaluator's relational operators. Callers must fall back to
136a full scan when this is `false`.
137
138##### Returns
139
140`boolean`
141
142#### Implementation of
143
144[`IndexInterface`](../interfaces/IndexInterface.md).[`supportsRangeOptimization`](../interfaces/IndexInterface.md#supportsrangeoptimization)
145
146***
147
148### valueMapData
149
150#### Get Signature
151
152```ts
153get valueMapData(): Map<any, Set<TKey>>;
154```
155
156Defined in: [packages/db/src/indexes/reverse-index.ts:132](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L132)
157
158##### Returns
159
160`Map`\<`any`, `Set`\<`TKey`\>\>
161
162#### Implementation of
163
164[`IndexInterface`](../interfaces/IndexInterface.md).[`valueMapData`](../interfaces/IndexInterface.md#valuemapdata)
165
166## Methods
167
168### add()
169
170```ts
171add(key, item): void;
172```
173
174Defined in: [packages/db/src/indexes/reverse-index.ts:96](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L96)
175
176#### Parameters
177
178##### key
179
180`TKey`
181
182##### item
183
184`any`
185
186#### Returns
187
188`void`
189
190#### Implementation of
191
192[`IndexInterface`](../interfaces/IndexInterface.md).[`add`](../interfaces/IndexInterface.md#add)
193
194***
195
196### build()
197
198```ts
199build(entries): void;
200```
201
202Defined in: [packages/db/src/indexes/reverse-index.ts:108](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L108)
203
204#### Parameters
205
206##### entries
207
208`Iterable`\<\[`TKey`, `any`\]\>
209
210#### Returns
211
212`void`
213
214#### Implementation of
215
216[`IndexInterface`](../interfaces/IndexInterface.md).[`build`](../interfaces/IndexInterface.md#build)
217
218***
219
220### clear()
221
222```ts
223clear(): void;
224```
225
226Defined in: [packages/db/src/indexes/reverse-index.ts:112](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L112)
227
228#### Returns
229
230`void`
231
232#### Implementation of
233
234[`IndexInterface`](../interfaces/IndexInterface.md).[`clear`](../interfaces/IndexInterface.md#clear)
235
236***
237
238### equalityLookup()
239
240```ts
241equalityLookup(value): Set<TKey>;
242```
243
244Defined in: [packages/db/src/indexes/reverse-index.ts:120](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L120)
245
246#### Parameters
247
248##### value
249
250`any`
251
252#### Returns
253
254`Set`\<`TKey`\>
255
256#### Implementation of
257
258[`IndexInterface`](../interfaces/IndexInterface.md).[`equalityLookup`](../interfaces/IndexInterface.md#equalitylookup)
259
260***
261
262### getStats()
263
264```ts
265getStats(): IndexStats;
266```
267
268Defined in: [packages/db/src/indexes/reverse-index.ts:92](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L92)
269
270#### Returns
271
272[`IndexStats`](../interfaces/IndexStats.md)
273
274#### Implementation of
275
276[`IndexInterface`](../interfaces/IndexInterface.md).[`getStats`](../interfaces/IndexInterface.md#getstats)
277
278***
279
280### inArrayLookup()
281
282```ts
283inArrayLookup(values): Set<TKey>;
284```
285
286Defined in: [packages/db/src/indexes/reverse-index.ts:124](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L124)
287
288#### Parameters
289
290##### values
291
292`any`[]
293
294#### Returns
295
296`Set`\<`TKey`\>
297
298#### Implementation of
299
300[`IndexInterface`](../interfaces/IndexInterface.md).[`inArrayLookup`](../interfaces/IndexInterface.md#inarraylookup)
301
302***
303
304### lookup()
305
306```ts
307lookup(operation, value): Set<TKey>;
308```
309
310Defined in: [packages/db/src/indexes/reverse-index.ts:17](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L17)
311
312#### Parameters
313
314##### operation
315
316`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
317
318##### value
319
320`any`
321
322#### Returns
323
324`Set`\<`TKey`\>
325
326#### Implementation of
327
328[`IndexInterface`](../interfaces/IndexInterface.md).[`lookup`](../interfaces/IndexInterface.md#lookup)
329
330***
331
332### matchesCompareOptions()
333
334```ts
335matchesCompareOptions(compareOptions): boolean;
336```
337
338Defined in: [packages/db/src/indexes/reverse-index.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L84)
339
340#### Parameters
341
342##### compareOptions
343
344`CompareOptions`
345
346#### Returns
347
348`boolean`
349
350#### Implementation of
351
352[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesCompareOptions`](../interfaces/IndexInterface.md#matchescompareoptions)
353
354***
355
356### matchesDirection()
357
358```ts
359matchesDirection(direction): boolean;
360```
361
362Defined in: [packages/db/src/indexes/reverse-index.ts:88](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L88)
363
364#### Parameters
365
366##### direction
367
368[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md)
369
370#### Returns
371
372`boolean`
373
374#### Implementation of
375
376[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesDirection`](../interfaces/IndexInterface.md#matchesdirection)
377
378***
379
380### matchesField()
381
382```ts
383matchesField(fieldPath): boolean;
384```
385
386Defined in: [packages/db/src/indexes/reverse-index.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L80)
387
388#### Parameters
389
390##### fieldPath
391
392`string`[]
393
394#### Returns
395
396`boolean`
397
398#### Implementation of
399
400[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesField`](../interfaces/IndexInterface.md#matchesfield)
401
402***
403
404### rangeQuery()
405
406```ts
407rangeQuery(options): Set<TKey>;
408```
409
410Defined in: [packages/db/src/indexes/reverse-index.ts:31](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L31)
411
412#### Parameters
413
414##### options
415
416[`BTreeRangeQueryOptions`](../interfaces/BTreeRangeQueryOptions.md) = `{}`
417
418#### Returns
419
420`Set`\<`TKey`\>
421
422#### Implementation of
423
424[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQuery`](../interfaces/IndexInterface.md#rangequery)
425
426***
427
428### rangeQueryReversed()
429
430```ts
431rangeQueryReversed(options): Set<TKey>;
432```
433
434Defined in: [packages/db/src/indexes/reverse-index.ts:35](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L35)
435
436#### Parameters
437
438##### options
439
440[`BTreeRangeQueryOptions`](../interfaces/BTreeRangeQueryOptions.md) = `{}`
441
442#### Returns
443
444`Set`\<`TKey`\>
445
446#### Implementation of
447
448[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQueryReversed`](../interfaces/IndexInterface.md#rangequeryreversed)
449
450***
451
452### remove()
453
454```ts
455remove(key, item): void;
456```
457
458Defined in: [packages/db/src/indexes/reverse-index.ts:100](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L100)
459
460#### Parameters
461
462##### key
463
464`TKey`
465
466##### item
467
468`any`
469
470#### Returns
471
472`void`
473
474#### Implementation of
475
476[`IndexInterface`](../interfaces/IndexInterface.md).[`remove`](../interfaces/IndexInterface.md#remove)
477
478***
479
480### supports()
481
482```ts
483supports(operation): boolean;
484```
485
486Defined in: [packages/db/src/indexes/reverse-index.ts:72](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L72)
487
488#### Parameters
489
490##### operation
491
492`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
493
494#### Returns
495
496`boolean`
497
498#### Implementation of
499
500[`IndexInterface`](../interfaces/IndexInterface.md).[`supports`](../interfaces/IndexInterface.md#supports)
501
502***
503
504### take()
505
506```ts
507take(
508 n,
509 from,
510 filterFn?): TKey[];
511```
512
513Defined in: [packages/db/src/indexes/reverse-index.ts:39](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L39)
514
515#### Parameters
516
517##### n
518
519`number`
520
521##### from
522
523`any`
524
525##### filterFn?
526
527(`key`) => `boolean`
528
529#### Returns
530
531`TKey`[]
532
533#### Implementation of
534
535[`IndexInterface`](../interfaces/IndexInterface.md).[`take`](../interfaces/IndexInterface.md#take)
536
537***
538
539### takeFromStart()
540
541```ts
542takeFromStart(n, filterFn?): TKey[];
543```
544
545Defined in: [packages/db/src/indexes/reverse-index.ts:43](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L43)
546
547#### Parameters
548
549##### n
550
551`number`
552
553##### filterFn?
554
555(`key`) => `boolean`
556
557#### Returns
558
559`TKey`[]
560
561#### Implementation of
562
563[`IndexInterface`](../interfaces/IndexInterface.md).[`takeFromStart`](../interfaces/IndexInterface.md#takefromstart)
564
565***
566
567### takeReversed()
568
569```ts
570takeReversed(
571 n,
572 from,
573 filterFn?): TKey[];
574```
575
576Defined in: [packages/db/src/indexes/reverse-index.ts:47](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L47)
577
578#### Parameters
579
580##### n
581
582`number`
583
584##### from
585
586`any`
587
588##### filterFn?
589
590(`key`) => `boolean`
591
592#### Returns
593
594`TKey`[]
595
596#### Implementation of
597
598[`IndexInterface`](../interfaces/IndexInterface.md).[`takeReversed`](../interfaces/IndexInterface.md#takereversed)
599
600***
601
602### takeReversedFromEnd()
603
604```ts
605takeReversedFromEnd(n, filterFn?): TKey[];
606```
607
608Defined in: [packages/db/src/indexes/reverse-index.ts:55](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L55)
609
610#### Parameters
611
612##### n
613
614`number`
615
616##### filterFn?
617
618(`key`) => `boolean`
619
620#### Returns
621
622`TKey`[]
623
624#### Implementation of
625
626[`IndexInterface`](../interfaces/IndexInterface.md).[`takeReversedFromEnd`](../interfaces/IndexInterface.md#takereversedfromend)
627
628***
629
630### update()
631
632```ts
633update(
634 key,
635 oldItem,
636 newItem): void;
637```
638
639Defined in: [packages/db/src/indexes/reverse-index.ts:104](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/reverse-index.ts#L104)
640
641#### Parameters
642
643##### key
644
645`TKey`
646
647##### oldItem
648
649`any`
650
651##### newItem
652
653`any`
654
655#### Returns
656
657`void`
658
659#### Implementation of
660
661[`IndexInterface`](../interfaces/IndexInterface.md).[`update`](../interfaces/IndexInterface.md#update)