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

ts
new LazyIndexWrapper<TKey>(
   id, 
   expression, 
   name, 
   resolver, 
   options, 
collectionEntries?): LazyIndexWrapper<TKey>;
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()

ts
getExpression(): BasicExpression;
getExpression(): BasicExpression;

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

Get the index expression

Returns

BasicExpression


getId()

ts
getId(): number;
getId(): number;

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

Get the index ID

Returns

number


getName()

ts
getName(): string | undefined;
getName(): string | undefined;

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

Get the index name

Returns

string | undefined


getResolved()

ts
getResolved(): BaseIndex<TKey>;
getResolved(): BaseIndex<TKey>;

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

Get resolved index (throws if not ready)

Returns

BaseIndex<TKey>


isResolved()

ts
isResolved(): boolean;
isResolved(): boolean;

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

Check if already resolved

Returns

boolean


resolve()

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

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

Resolve the actual index

Returns

Promise<BaseIndex<TKey>>

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.