Source: https://tanstack.com/db/latest/docs/reference/classes/IndexProxy

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

• Class: IndexProxy<TKey>

• Type Parameters

• TKey

• Constructors

• Constructor

• Parameters

• indexId

• lazyIndex

• Returns

• Accessors

• expression

• Get Signature

• Returns

• id

• Get Signature

• Returns

• index

• Get Signature

• Returns

• indexedKeysSet

• Get Signature

• Returns

• isReady

• Get Signature

• Returns

• keyCount

• Get Signature

• Returns

• name

• Get Signature

• Returns

• orderedEntriesArray

• Get Signature

• Returns

• valueMapData

• Get Signature

• Returns

• Methods

• _getLazyWrapper()

• Returns

• equalityLookup()

• Parameters

• value

• Returns

• getStats()

• Returns

• inArrayLookup()

• Parameters

• values

• Returns

• matchesField()

• Parameters

• fieldPath

• Returns

• rangeQuery()

• Parameters

• options

• Returns

• supports()

• Parameters

• operation

• Returns

• whenReady()

• Returns

IndexProxy

Copy Markdown

Class: IndexProxy<TKey>
=======================

Defined in: packages/db/src/indexes/lazy-index.ts:131

Proxy that provides synchronous interface while index loads asynchronously

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

TKey extends string | number = string | number

Constructors
------------ ### Constructor

ts

new IndexProxy<TKey>(indexId, lazyIndex): IndexProxy<TKey>;


new IndexProxy<TKey>(indexId, lazyIndex): IndexProxy<TKey>;

Defined in: packages/db/src/indexes/lazy-index.ts:132

#### Parameters ##### indexId

number

##### lazyIndex

LazyIndexWrapper <TKey>

#### Returns

IndexProxy<TKey>

Accessors
--------- ### expression #### Get Signature

ts

get expression(): BasicExpression;


get expression(): BasicExpression;

Defined in: packages/db/src/indexes/lazy-index.ts:178

Get the index expression (available immediately)

##### Returns

BasicExpression

---

### id #### Get Signature

ts

get id(): number;


get id(): number;

Defined in: packages/db/src/indexes/lazy-index.ts:161

Get the index ID

##### Returns

number

---

### index #### Get Signature

ts

get index(): BaseIndex<TKey>;


get index(): BaseIndex<TKey>;

Defined in: packages/db/src/indexes/lazy-index.ts:140

Get the resolved index (throws if not ready)

##### Returns

BaseIndex <TKey>

---

### indexedKeysSet #### Get Signature

ts

get indexedKeysSet(): Set<TKey>;


get indexedKeysSet(): Set<TKey>;

Defined in: packages/db/src/indexes/lazy-index.ts:216

##### Returns

Set<TKey>

---

### isReady #### Get Signature

ts

get isReady(): boolean;


get isReady(): boolean;

Defined in: packages/db/src/indexes/lazy-index.ts:147

Check if index is ready

##### Returns

boolean

---

### keyCount #### Get Signature

ts

get keyCount(): number;


get keyCount(): number;

Defined in: packages/db/src/indexes/lazy-index.ts:211

Get the key count (throws if not ready)

##### Returns

number

---

### name #### Get Signature

ts

get name(): string | undefined;


get name(): string | undefined;

Defined in: packages/db/src/indexes/lazy-index.ts:168

Get the index name (throws if not ready)

##### Returns

string | undefined

---

### orderedEntriesArray #### Get Signature

ts

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


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

Defined in: packages/db/src/indexes/lazy-index.ts:221

##### 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/lazy-index.ts:226

##### Returns

Map<any, Set<TKey>>

Methods
------- ### _getLazyWrapper()

ts

_getLazyWrapper(): LazyIndexWrapper<TKey>;


_getLazyWrapper(): LazyIndexWrapper<TKey>;

Defined in: packages/db/src/indexes/lazy-index.ts:248

#### Returns

LazyIndexWrapper <TKey>

---

### equalityLookup()

ts

equalityLookup(value): Set<TKey>;


equalityLookup(value): Set<TKey>;

Defined in: packages/db/src/indexes/lazy-index.ts:232

#### Parameters ##### value

any

#### Returns

Set<TKey>

---

### getStats()

ts

getStats(): IndexStats;


getStats(): IndexStats;

Defined in: packages/db/src/indexes/lazy-index.ts:192

Get index statistics (throws if not ready)

#### Returns

IndexStats

---

### inArrayLookup()

ts

inArrayLookup(values): Set<TKey>;


inArrayLookup(values): Set<TKey>;

Defined in: packages/db/src/indexes/lazy-index.ts:242

#### Parameters ##### values

any[]

#### Returns

Set<TKey>

---

### matchesField()

ts

matchesField(fieldPath): boolean;


matchesField(fieldPath): boolean;

Defined in: packages/db/src/indexes/lazy-index.ts:199

Check if index matches a field path (available immediately)

#### Parameters ##### fieldPath

string[]

#### Returns

boolean

---

### rangeQuery()

ts

rangeQuery(options): Set<TKey>;


rangeQuery(options): Set<TKey>;

Defined in: packages/db/src/indexes/lazy-index.ts:237

#### Parameters ##### options

any

#### Returns

Set<TKey>

---

### supports()

ts

supports(operation): boolean;


supports(operation): boolean;

Defined in: packages/db/src/indexes/lazy-index.ts:185

Check if index supports an operation (throws if not ready)

#### Parameters ##### operation

any

#### Returns

boolean

---

### whenReady()

ts

whenReady(): Promise<BaseIndex<TKey>>;


whenReady(): Promise<BaseIndex<TKey>>;

Defined in: packages/db/src/indexes/lazy-index.ts:154

Wait for index to be ready

#### Returns

Promise<BaseIndex <TKey>>

Edit on GitHub

Home

Partners Become a Partner