Source: https://tanstack.com/db/latest/docs/reference/interfaces/IndexInterface

TanStack

DB v0v0

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React

Version

Latest

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Quick Start
  
  core

• Installation
  
  core

Guides

• Live Queries
  
  core

• Mutations
  
  core

• Schemas
  
  core

• Error Handling
  
  core

• Creating Collection Options Creators
  
  core

Collections

• Query Collection
  
  core

• Electric Collection
  
  core

• TrailBase Collection
  
  core

• RxDB Collection
  
  core

• PowerSync Collection
  
  core

• LocalStorage Collection
  
  core

• LocalOnly Collection
  
  core

Frameworks

• React
  
  core

• Vue
  
  core

• Angular
  
  core

• Solid
  
  core

• Svelte
  
  core

Community

• Resources & Packages
  
  core

API Reference

• Core API Reference
  
  core

• Collection
  
  core

• createCollection
  
  core

• liveQueryCollectionOptions
  
  core

• createLiveQueryCollection
  
  core

• createOptimisticAction
  
  core

• createTransaction
  
  core

• Electric DB Collection
  
  core

• electricCollectionOptions
  
  core

• Query DB Collection
  
  core

• queryCollectionOptions
  
  core

• RxDB DB Collection
  
  core

• rxdbCollectionOptions
  
  core

• PowerSync Collection
  
  core

• powerSyncCollectionOptions
  
  core

• React Hooks
  
  react

• useLiveQuery
  
  react

Framework

React

Version

Latest

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Quick Start
  
  core

• Installation
  
  core

Guides

• Live Queries
  
  core

• Mutations
  
  core

• Schemas
  
  core

• Error Handling
  
  core

• Creating Collection Options Creators
  
  core

Collections

• Query Collection
  
  core

• Electric Collection
  
  core

• TrailBase Collection
  
  core

• RxDB Collection
  
  core

• PowerSync Collection
  
  core

• LocalStorage Collection
  
  core

• LocalOnly Collection
  
  core

Frameworks

• React
  
  core

• Vue
  
  core

• Angular
  
  core

• Solid
  
  core

• Svelte
  
  core

Community

• Resources & Packages
  
  core

API Reference

• Core API Reference
  
  core

• Collection
  
  core

• createCollection
  
  core

• liveQueryCollectionOptions
  
  core

• createLiveQueryCollection
  
  core

• createOptimisticAction
  
  core

• createTransaction
  
  core

• Electric DB Collection
  
  core

• electricCollectionOptions
  
  core

• Query DB Collection
  
  core

• queryCollectionOptions
  
  core

• RxDB DB Collection
  
  core

• rxdbCollectionOptions
  
  core

• PowerSync Collection
  
  core

• powerSyncCollectionOptions
  
  core

• React Hooks
  
  react

• useLiveQuery
  
  react

On this page

• Interface: IndexInterface<TKey>

• Type Parameters

• TKey

• Properties

• add()

• Parameters

• key

• item

• Returns

• build()

• Parameters

• entries

• Returns

• clear()

• Returns

• equalityLookup()

• Parameters

• value

• Returns

• getStats()

• Returns

• inArrayLookup()

• Parameters

• values

• Returns

• lookup()

• Parameters

• operation

• value

• Returns

• matchesCompareOptions()

• Parameters

• compareOptions

• Returns

• matchesDirection()

• Parameters

• direction

• Returns

• matchesField()

• Parameters

• fieldPath

• Returns

• rangeQuery()

• Parameters

• options

• Returns

• rangeQueryReversed()

• Parameters

• options

• Returns

• remove()

• Parameters

• key

• item

• Returns

• supports()

• Parameters

• operation

• Returns

• take()

• Parameters

• n

• from?

• filterFn?

• Returns

• takeReversed()

• Parameters

• n

• from?

• filterFn?

• Returns

• update()

• Parameters

• key

• oldItem

• newItem

• Returns

• Accessors

• indexedKeysSet

• Get Signature

• Returns

• keyCount

• Get Signature

• Returns

• orderedEntriesArray

• Get Signature

• Returns

• orderedEntriesArrayReversed

• Get Signature

• Returns

• valueMapData

• Get Signature

• Returns

IndexInterface

Copy Markdown

Interface: IndexInterface<TKey>
===============================

Defined in: packages/db/src/indexes/base-index.ts:28

Type Parameters
--------------- ### TKey

TKey extends string | number = string | number

Properties
---------- ### add()

ts

add: (key, item) => void;


add: (key, item) => void;

Defined in: packages/db/src/indexes/base-index.ts:31

#### Parameters ##### key

TKey

##### item

any

#### Returns

void

---

### build()

ts

build: (entries) => void;


build: (entries) => void;

Defined in: packages/db/src/indexes/base-index.ts:35

#### Parameters ##### entries

Iterable<[TKey, any]>

#### Returns

void

---

### clear()

ts

clear: () => void;


clear: () => void;

Defined in: packages/db/src/indexes/base-index.ts:36

#### Returns

void

---

### equalityLookup()

ts

equalityLookup: (value) => Set<TKey>;


equalityLookup: (value) => Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:40

#### Parameters ##### value

any

#### Returns

Set<TKey>

---

### getStats()

ts

getStats: () => IndexStats;


getStats: () => IndexStats;

Defined in: packages/db/src/indexes/base-index.ts:70

#### Returns

IndexStats

---

### inArrayLookup()

ts

inArrayLookup: (values) => Set<TKey>;


inArrayLookup: (values) => Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:41

#### Parameters ##### values

any[]

#### Returns

Set<TKey>

---

### lookup()

ts

lookup: (operation, value) => Set<TKey>;


lookup: (operation, value) => Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:38

#### Parameters ##### operation

"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"

##### value

any

#### Returns

Set<TKey>

---

### matchesCompareOptions()

ts

matchesCompareOptions: (compareOptions) => boolean;


matchesCompareOptions: (compareOptions) => boolean;

Defined in: packages/db/src/indexes/base-index.ts:67

#### Parameters ##### compareOptions

CompareOptions

#### Returns

boolean

---

### matchesDirection()

ts

matchesDirection: (direction) => boolean;


matchesDirection: (direction) => boolean;

Defined in: packages/db/src/indexes/base-index.ts:68

#### Parameters ##### direction

OrderByDirection

#### Returns

boolean

---

### matchesField()

ts

matchesField: (fieldPath) => boolean;


matchesField: (fieldPath) => boolean;

Defined in: packages/db/src/indexes/base-index.ts:66

#### Parameters ##### fieldPath

string[]

#### Returns

boolean

---

### rangeQuery()

ts

rangeQuery: (options) => Set<TKey>;


rangeQuery: (options) => Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:43

#### Parameters ##### options

RangeQueryOptions

#### Returns

Set<TKey>

---

### rangeQueryReversed()

ts

rangeQueryReversed: (options) => Set<TKey>;


rangeQueryReversed: (options) => Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:44

#### Parameters ##### options

RangeQueryOptions

#### Returns

Set<TKey>

---

### remove()

ts

remove: (key, item) => void;


remove: (key, item) => void;

Defined in: packages/db/src/indexes/base-index.ts:32

#### Parameters ##### key

TKey

##### item

any

#### Returns

void

---

### supports()

ts

supports: (operation) => boolean;


supports: (operation) => boolean;

Defined in: packages/db/src/indexes/base-index.ts:64

#### Parameters ##### operation

"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"

#### Returns

boolean

---

### take()

ts

take: (n, from?, filterFn?) => TKey[];


take: (n, from?, filterFn?) => TKey[];

Defined in: packages/db/src/indexes/base-index.ts:46

#### Parameters ##### n

number

##### from?

TKey

##### filterFn?

(key) => boolean

#### Returns

TKey[]

---

### takeReversed()

ts

takeReversed: (n, from?, filterFn?) => TKey[];


takeReversed: (n, from?, filterFn?) => TKey[];

Defined in: packages/db/src/indexes/base-index.ts:51

#### Parameters ##### n

number

##### from?

TKey

##### filterFn?

(key) => boolean

#### Returns

TKey[]

---

### update()

ts

update: (key, oldItem, newItem) => void;


update: (key, oldItem, newItem) => void;

Defined in: packages/db/src/indexes/base-index.ts:33

#### Parameters ##### key

TKey

##### oldItem

any

##### newItem

any

#### Returns

void

Accessors
--------- ### indexedKeysSet #### Get Signature

ts

get indexedKeysSet(): Set<TKey>;


get indexedKeysSet(): Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:61

##### Returns

Set<TKey>

---

### keyCount #### Get Signature

ts

get keyCount(): number;


get keyCount(): number;

Defined in: packages/db/src/indexes/base-index.ts:57

##### Returns

number

---

### orderedEntriesArray #### Get Signature

ts

get orderedEntriesArray(): [any, Set<TKey>][];


get orderedEntriesArray(): [any, Set<TKey>][];

Defined in: packages/db/src/indexes/base-index.ts:58

##### Returns

[any, Set<TKey>][]

---

### orderedEntriesArrayReversed #### Get Signature

ts

get orderedEntriesArrayReversed(): [any, Set<TKey>][];


get orderedEntriesArrayReversed(): [any, Set<TKey>][];

Defined in: packages/db/src/indexes/base-index.ts:59

##### Returns

[any, Set<TKey>][]

---

### valueMapData #### Get Signature

ts

get valueMapData(): Map<any, Set<TKey>>;


get valueMapData(): Map<any, Set<TKey>>;

Defined in: packages/db/src/indexes/base-index.ts:62

##### Returns

Map<any, Set<TKey>>

Edit on GitHub

Home

Partners Become a Partner