Open History to see the last commit
1---
2id: BaseIndex
3title: BaseIndex
4---
5
6Defined in: [packages/db/src/indexes/base-index.ts:119](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L119)
7
8Base abstract class that all index types extend
9
10## Extended by
11
12- [`BasicIndex`](BasicIndex.md)
13- [`BTreeIndex`](BTreeIndex.md)
14
15## Type Parameters
16
17### TKey
18
19`TKey` *extends* `string` \| `number` = `string` \| `number`
20
21## Implements
22
23- [`IndexInterface`](../interfaces/IndexInterface.md)\<`TKey`\>
24
25## Constructors
26
27### Constructor
28
29```ts
30new BaseIndex<TKey>(
31 id,
32 expression,
33 name?,
34options?): BaseIndex<TKey>;
35```
36
37Defined in: [packages/db/src/indexes/base-index.ts:140](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L140)
38
39#### Parameters
40
41##### id
42
43`number`
44
45##### expression
46
47[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)
48
49##### name?
50
51`string`
52
53##### options?
54
55`any`
56
57#### Returns
58
59`BaseIndex`\<`TKey`\>
60
61## Properties
62
63### compareFn()
64
65```ts
66protected readonly compareFn: (a, b) => number;
67```
68
69Defined in: [packages/db/src/indexes/base-index.ts:131](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L131)
70
71Orders indexed values. Every result is checked, because a custom
72comparator or custom collation may be supplied by the user.
73
74#### Parameters
75
76##### a
77
78`any`
79
80##### b
81
82`any`
83
84#### Returns
85
86`number`
87
88***
89
90### compareOptions
91
92```ts
93protected readonly compareOptions: CompareOptions;
94```
95
96Defined in: [packages/db/src/indexes/base-index.ts:126](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L126)
97
98***
99
100### expression
101
102```ts
103readonly expression: BasicExpression;
104```
105
106Defined in: [packages/db/src/indexes/base-index.ts:124](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L124)
107
108***
109
110### hasCustomComparator
111
112```ts
113protected readonly hasCustomComparator: boolean;
114```
115
116Defined in: [packages/db/src/indexes/base-index.ts:137](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L137)
117
118A user-supplied comparator's ordering may not match the WHERE evaluator's
119relational operators.
120
121***
122
123### id
124
125```ts
126readonly id: number;
127```
128
129Defined in: [packages/db/src/indexes/base-index.ts:122](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L122)
130
131***
132
133### name?
134
135```ts
136readonly optional name: string;
137```
138
139Defined in: [packages/db/src/indexes/base-index.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L123)
140
141***
142
143### supportedOperations
144
145```ts
146abstract readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;
147```
148
149Defined in: [packages/db/src/indexes/base-index.ts:125](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L125)
150
151## Accessors
152
153### keyCount
154
155#### Get Signature
156
157```ts
158get abstract keyCount(): number;
159```
160
161Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L182)
162
163##### Returns
164
165`number`
166
167#### Implementation of
168
169[`IndexInterface`](../interfaces/IndexInterface.md).[`keyCount`](../interfaces/IndexInterface.md#keycount)
170
171***
172
173### supportsRangeOptimization
174
175#### Get Signature
176
177```ts
178get supportsRangeOptimization(): boolean;
179```
180
181Defined in: [packages/db/src/indexes/base-index.ts:206](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L206)
182
183Whether range lookups (gt/gte/lt/lte) on this index can be trusted to
184return every matching key. Range traversal relies on the index ordering, so
185it is unsafe when the index uses a custom comparator, whose order may not
186match the WHERE evaluator's relational operators. Callers must fall back to
187a full scan when this is `false`.
188
189##### Returns
190
191`boolean`
192
193#### Implementation of
194
195[`IndexInterface`](../interfaces/IndexInterface.md).[`supportsRangeOptimization`](../interfaces/IndexInterface.md#supportsrangeoptimization)
196
197## Methods
198
199### add()
200
201```ts
202abstract add(key, item): void;
203```
204
205Defined in: [packages/db/src/indexes/base-index.ts:158](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L158)
206
207#### Parameters
208
209##### key
210
211`TKey`
212
213##### item
214
215`any`
216
217#### Returns
218
219`void`
220
221#### Implementation of
222
223[`IndexInterface`](../interfaces/IndexInterface.md).[`add`](../interfaces/IndexInterface.md#add)
224
225***
226
227### addRangeValue()
228
229```ts
230protected addRangeValue(value): void;
231```
232
233Defined in: [packages/db/src/indexes/base-index.ts:210](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L210)
234
235#### Parameters
236
237##### value
238
239`unknown`
240
241#### Returns
242
243`void`
244
245***
246
247### build()
248
249```ts
250abstract build(entries): void;
251```
252
253Defined in: [packages/db/src/indexes/base-index.ts:161](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L161)
254
255#### Parameters
256
257##### entries
258
259`Iterable`\<\[`TKey`, `any`\]\>
260
261#### Returns
262
263`void`
264
265#### Implementation of
266
267[`IndexInterface`](../interfaces/IndexInterface.md).[`build`](../interfaces/IndexInterface.md#build)
268
269***
270
271### canOptimizeRangeFor()
272
273```ts
274canOptimizeRangeFor(value): boolean;
275```
276
277Defined in: [packages/db/src/indexes/base-index.ts:232](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L232)
278
279Whether the live values in this index share the predicate operand's
280relational domain. Mixed domains can sort differently in the index and
281WHERE evaluator, which can make a range lookup omit matching rows.
282
283#### Parameters
284
285##### value
286
287`unknown`
288
289#### Returns
290
291`boolean`
292
293#### Implementation of
294
295[`IndexInterface`](../interfaces/IndexInterface.md).[`canOptimizeRangeFor`](../interfaces/IndexInterface.md#canoptimizerangefor)
296
297***
298
299### clear()
300
301```ts
302abstract clear(): void;
303```
304
305Defined in: [packages/db/src/indexes/base-index.ts:162](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L162)
306
307#### Returns
308
309`void`
310
311#### Implementation of
312
313[`IndexInterface`](../interfaces/IndexInterface.md).[`clear`](../interfaces/IndexInterface.md#clear)
314
315***
316
317### clearRangeValues()
318
319```ts
320protected clearRangeValues(): void;
321```
322
323Defined in: [packages/db/src/indexes/base-index.ts:228](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L228)
324
325#### Returns
326
327`void`
328
329***
330
331### equalityLookup()
332
333```ts
334abstract equalityLookup(value): Set<TKey>;
335```
336
337Defined in: [packages/db/src/indexes/base-index.ts:183](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L183)
338
339#### Parameters
340
341##### value
342
343`any`
344
345#### Returns
346
347`Set`\<`TKey`\>
348
349#### Implementation of
350
351[`IndexInterface`](../interfaces/IndexInterface.md).[`equalityLookup`](../interfaces/IndexInterface.md#equalitylookup)
352
353***
354
355### evaluateAddedValue()
356
357```ts
358protected evaluateAddedValue(key, item): any;
359```
360
361Defined in: [packages/db/src/indexes/base-index.ts:307](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L307)
362
363The indexed value of a row being added. A throwing expression fails the write.
364
365#### Parameters
366
367##### key
368
369`TKey`
370
371##### item
372
373`any`
374
375#### Returns
376
377`any`
378
379***
380
381### evaluateIndexExpression()
382
383```ts
384protected evaluateIndexExpression(item): any;
385```
386
387Defined in: [packages/db/src/indexes/base-index.ts:300](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L300)
388
389#### Parameters
390
391##### item
392
393`any`
394
395#### Returns
396
397`any`
398
399***
400
401### inArrayLookup()
402
403```ts
404abstract inArrayLookup(values): Set<TKey>;
405```
406
407Defined in: [packages/db/src/indexes/base-index.ts:184](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L184)
408
409#### Parameters
410
411##### values
412
413`any`[]
414
415#### Returns
416
417`Set`\<`TKey`\>
418
419#### Implementation of
420
421[`IndexInterface`](../interfaces/IndexInterface.md).[`inArrayLookup`](../interfaces/IndexInterface.md#inarraylookup)
422
423***
424
425### initialize()
426
427```ts
428abstract protected initialize(options?): void;
429```
430
431Defined in: [packages/db/src/indexes/base-index.ts:298](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L298)
432
433#### Parameters
434
435##### options?
436
437`any`
438
439#### Returns
440
441`void`
442
443***
444
445### lookup()
446
447```ts
448abstract lookup(operation, value): Set<TKey>;
449```
450
451Defined in: [packages/db/src/indexes/base-index.ts:163](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L163)
452
453#### Parameters
454
455##### operation
456
457`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
458
459##### value
460
461`any`
462
463#### Returns
464
465`Set`\<`TKey`\>
466
467#### Implementation of
468
469[`IndexInterface`](../interfaces/IndexInterface.md).[`lookup`](../interfaces/IndexInterface.md#lookup)
470
471***
472
473### matchesCompareOptions()
474
475```ts
476matchesCompareOptions(compareOptions): boolean;
477```
478
479Defined in: [packages/db/src/indexes/base-index.ts:254](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L254)
480
481Checks if the compare options match the index's compare options.
482The direction is ignored because the index can be reversed if the direction is different.
483
484#### Parameters
485
486##### compareOptions
487
488`CompareOptions`
489
490#### Returns
491
492`boolean`
493
494#### Implementation of
495
496[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesCompareOptions`](../interfaces/IndexInterface.md#matchescompareoptions)
497
498***
499
500### matchesDirection()
501
502```ts
503matchesDirection(direction): boolean;
504```
505
506Defined in: [packages/db/src/indexes/base-index.ts:294](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L294)
507
508Checks if the index matches the provided direction.
509
510#### Parameters
511
512##### direction
513
514[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md)
515
516#### Returns
517
518`boolean`
519
520#### Implementation of
521
522[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesDirection`](../interfaces/IndexInterface.md#matchesdirection)
523
524***
525
526### matchesField()
527
528```ts
529matchesField(fieldPath): boolean;
530```
531
532Defined in: [packages/db/src/indexes/base-index.ts:242](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L242)
533
534#### Parameters
535
536##### fieldPath
537
538`string`[]
539
540#### Returns
541
542`boolean`
543
544#### Implementation of
545
546[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesField`](../interfaces/IndexInterface.md#matchesfield)
547
548***
549
550### rangeQuery()
551
552```ts
553abstract rangeQuery(options): Set<TKey>;
554```
555
556Defined in: [packages/db/src/indexes/base-index.ts:185](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L185)
557
558#### Parameters
559
560##### options
561
562[`BTreeRangeQueryOptions`](../interfaces/BTreeRangeQueryOptions.md)
563
564#### Returns
565
566`Set`\<`TKey`\>
567
568#### Implementation of
569
570[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQuery`](../interfaces/IndexInterface.md#rangequery)
571
572***
573
574### rangeQueryReversed()
575
576```ts
577rangeQueryReversed(options): Set<TKey>;
578```
579
580Defined in: [packages/db/src/indexes/base-index.ts:188](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L188)
581
582#### Parameters
583
584##### options
585
586[`BTreeRangeQueryOptions`](../interfaces/BTreeRangeQueryOptions.md) = `{}`
587
588#### Returns
589
590`Set`\<`TKey`\>
591
592#### Implementation of
593
594[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQueryReversed`](../interfaces/IndexInterface.md#rangequeryreversed)
595
596***
597
598### remove()
599
600```ts
601abstract remove(key, item): void;
602```
603
604Defined in: [packages/db/src/indexes/base-index.ts:159](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L159)
605
606#### Parameters
607
608##### key
609
610`TKey`
611
612##### item
613
614`any`
615
616#### Returns
617
618`void`
619
620#### Implementation of
621
622[`IndexInterface`](../interfaces/IndexInterface.md).[`remove`](../interfaces/IndexInterface.md#remove)
623
624***
625
626### removeRangeValue()
627
628```ts
629protected removeRangeValue(value): void;
630```
631
632Defined in: [packages/db/src/indexes/base-index.ts:219](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L219)
633
634#### Parameters
635
636##### value
637
638`unknown`
639
640#### Returns
641
642`void`
643
644***
645
646### supports()
647
648```ts
649supports(operation): boolean;
650```
651
652Defined in: [packages/db/src/indexes/base-index.ts:202](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L202)
653
654#### Parameters
655
656##### operation
657
658`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
659
660#### Returns
661
662`boolean`
663
664#### Implementation of
665
666[`IndexInterface`](../interfaces/IndexInterface.md).[`supports`](../interfaces/IndexInterface.md#supports)
667
668***
669
670### take()
671
672```ts
673abstract take(
674 n,
675 from,
676 filterFn?): TKey[];
677```
678
679Defined in: [packages/db/src/indexes/base-index.ts:164](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L164)
680
681#### Parameters
682
683##### n
684
685`number`
686
687##### from
688
689`unknown`
690
691##### filterFn?
692
693(`key`) => `boolean`
694
695#### Returns
696
697`TKey`[]
698
699#### Implementation of
700
701[`IndexInterface`](../interfaces/IndexInterface.md).[`take`](../interfaces/IndexInterface.md#take)
702
703***
704
705### takeFromStart()
706
707```ts
708abstract takeFromStart(n, filterFn?): TKey[];
709```
710
711Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L169)
712
713#### Parameters
714
715##### n
716
717`number`
718
719##### filterFn?
720
721(`key`) => `boolean`
722
723#### Returns
724
725`TKey`[]
726
727#### Implementation of
728
729[`IndexInterface`](../interfaces/IndexInterface.md).[`takeFromStart`](../interfaces/IndexInterface.md#takefromstart)
730
731***
732
733### takeReversed()
734
735```ts
736abstract takeReversed(
737 n,
738 from,
739 filterFn?): TKey[];
740```
741
742Defined in: [packages/db/src/indexes/base-index.ts:173](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L173)
743
744#### Parameters
745
746##### n
747
748`number`
749
750##### from
751
752`unknown`
753
754##### filterFn?
755
756(`key`) => `boolean`
757
758#### Returns
759
760`TKey`[]
761
762#### Implementation of
763
764[`IndexInterface`](../interfaces/IndexInterface.md).[`takeReversed`](../interfaces/IndexInterface.md#takereversed)
765
766***
767
768### takeReversedFromEnd()
769
770```ts
771abstract takeReversedFromEnd(n, filterFn?): TKey[];
772```
773
774Defined in: [packages/db/src/indexes/base-index.ts:178](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L178)
775
776#### Parameters
777
778##### n
779
780`number`
781
782##### filterFn?
783
784(`key`) => `boolean`
785
786#### Returns
787
788`TKey`[]
789
790#### Implementation of
791
792[`IndexInterface`](../interfaces/IndexInterface.md).[`takeReversedFromEnd`](../interfaces/IndexInterface.md#takereversedfromend)
793
794***
795
796### update()
797
798```ts
799abstract update(
800 key,
801 oldItem,
802 newItem): void;
803```
804
805Defined in: [packages/db/src/indexes/base-index.ts:160](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L160)
806
807#### Parameters
808
809##### key
810
811`TKey`
812
813##### oldItem
814
815`any`
816
817##### newItem
818
819`any`
820
821#### Returns
822
823`void`
824
825#### Implementation of
826
827[`IndexInterface`](../interfaces/IndexInterface.md).[`update`](../interfaces/IndexInterface.md#update)