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