Defined in: packages/db/src/indexes/lazy-index.ts:131
Proxy that provides synchronous interface while index loads asynchronously
• TKey extends string | number = string | number
new IndexProxy<TKey>(indexId, lazyIndex): IndexProxy<TKey>
new IndexProxy<TKey>(indexId, lazyIndex): IndexProxy<TKey>
Defined in: packages/db/src/indexes/lazy-index.ts:132
number
LazyIndexWrapper<TKey>
IndexProxy<TKey>
get expression(): BasicExpression
get expression(): BasicExpression
Defined in: packages/db/src/indexes/lazy-index.ts:178
Get the index expression (available immediately)
BasicExpression
get id(): number
get id(): number
Defined in: packages/db/src/indexes/lazy-index.ts:161
Get the index ID
number
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)
BaseIndex<TKey>
get indexedKeysSet(): Set<TKey>
get indexedKeysSet(): Set<TKey>
Defined in: packages/db/src/indexes/lazy-index.ts:216
Set<TKey>
get isReady(): boolean
get isReady(): boolean
Defined in: packages/db/src/indexes/lazy-index.ts:147
Check if index is ready
boolean
get keyCount(): number
get keyCount(): number
Defined in: packages/db/src/indexes/lazy-index.ts:211
Get the key count (throws if not ready)
number
get name(): undefined | string
get name(): undefined | string
Defined in: packages/db/src/indexes/lazy-index.ts:168
Get the index name (throws if not ready)
undefined | string
get orderedEntriesArray(): [any, Set<TKey>][]
get orderedEntriesArray(): [any, Set<TKey>][]
Defined in: packages/db/src/indexes/lazy-index.ts:221
[any, Set<TKey>][]
get valueMapData(): Map<any, Set<TKey>>
get valueMapData(): Map<any, Set<TKey>>
Defined in: packages/db/src/indexes/lazy-index.ts:226
Map<any, Set<TKey>>
_getLazyWrapper(): LazyIndexWrapper<TKey>
_getLazyWrapper(): LazyIndexWrapper<TKey>
Defined in: packages/db/src/indexes/lazy-index.ts:248
LazyIndexWrapper<TKey>
equalityLookup(value): Set<TKey>
equalityLookup(value): Set<TKey>
Defined in: packages/db/src/indexes/lazy-index.ts:232
any
Set<TKey>
getStats(): IndexStats
getStats(): IndexStats
Defined in: packages/db/src/indexes/lazy-index.ts:192
Get index statistics (throws if not ready)
inArrayLookup(values): Set<TKey>
inArrayLookup(values): Set<TKey>
Defined in: packages/db/src/indexes/lazy-index.ts:242
any[]
Set<TKey>
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)
string[]
boolean
rangeQuery(options): Set<TKey>
rangeQuery(options): Set<TKey>
Defined in: packages/db/src/indexes/lazy-index.ts:237
any
Set<TKey>
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)
any
boolean
whenReady(): Promise<BaseIndex<TKey>>
whenReady(): Promise<BaseIndex<TKey>>
Defined in: packages/db/src/indexes/lazy-index.ts:154
Wait for index to be ready
Promise<BaseIndex<TKey>>