IndexInterface

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>>