Skip to content

LazyIndexWrapper.md

Latest commit

 

History

History
158 lines (91 loc) · 2.72 KB

LazyIndexWrapper.md

File metadata and controls

158 lines (91 loc) · 2.72 KB
id LazyIndexWrapper
title LazyIndexWrapper

Class: LazyIndexWrapper<TKey>

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

Wrapper that defers index creation until first sync

Type Parameters

TKey

TKey extends string | number = string | number

Constructors

Constructor

new LazyIndexWrapper<TKey>(
   id, 
   expression, 
   name, 
   resolver, 
   options, 
collectionEntries?): LazyIndexWrapper<TKey>;

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

Parameters

id

number

expression

BasicExpression

name

string | undefined

resolver

IndexResolver<TKey>

options

any

collectionEntries?

Iterable<[TKey, any], any, any>

Returns

LazyIndexWrapper<TKey>

Methods

getExpression()

getExpression(): BasicExpression;

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

Get the index expression

Returns

BasicExpression

getId()

getId(): number;

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

Get the index ID

Returns

number

getName()

getName(): string | undefined;

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

Get the index name

Returns

string | undefined

getResolved()

getResolved(): BaseIndex<TKey>;

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

Get resolved index (throws if not ready)

Returns

BaseIndex<TKey>

isResolved()

isResolved(): boolean;

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

Check if already resolved

Returns

boolean

resolve()

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

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

Resolve the actual index

Returns

Promise<BaseIndex<TKey>>