Interface: IndexInterface<TKey>#
Defined in: packages/db/src/indexes/base-index.ts:28
Type Parameters#
TKey#
TKey extends string | number = string | number
Properties#
add()#
add: (key, item) => void;
Defined in: packages/db/src/indexes/base-index.ts:31
Parameters#
key#
TKey
item#
any
Returns#
void
build()#
build: (entries) => void;
Defined in: packages/db/src/indexes/base-index.ts:35
Parameters#
entries#
Iterable<[TKey, any]>
Returns#
void
clear()#
clear: () => void;
Defined in: packages/db/src/indexes/base-index.ts:36
Returns#
void
equalityLookup()#
equalityLookup: (value) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:40
Parameters#
value#
any
Returns#
Set<TKey>
getStats()#
getStats: () => IndexStats;
Defined in: packages/db/src/indexes/base-index.ts:84
Returns#
inArrayLookup()#
inArrayLookup: (values) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:41
Parameters#
values#
any[]
Returns#
Set<TKey>
lookup()#
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()#
matchesCompareOptions: (compareOptions) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:81
Parameters#
compareOptions#
CompareOptions
Returns#
boolean
matchesDirection()#
matchesDirection: (direction) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:82
Parameters#
direction#
Returns#
boolean
matchesField()#
matchesField: (fieldPath) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:80
Parameters#
fieldPath#
string[]
Returns#
boolean
rangeQuery()#
rangeQuery: (options) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:43
Parameters#
options#
Returns#
Set<TKey>
rangeQueryReversed()#
rangeQueryReversed: (options) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:44
Parameters#
options#
Returns#
Set<TKey>
remove()#
remove: (key, item) => void;
Defined in: packages/db/src/indexes/base-index.ts:32
Parameters#
key#
TKey
item#
any
Returns#
void
supports()#
supports: (operation) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:69
Parameters#
operation#
"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"
Returns#
boolean
take()#
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[]
takeFromStart()#
takeFromStart: (n, filterFn?) => TKey[];
Defined in: packages/db/src/indexes/base-index.ts:51
Parameters#
n#
number
filterFn?#
(key) => boolean
Returns#
TKey[]
takeReversed()#
takeReversed: (n, from, filterFn?) => TKey[];
Defined in: packages/db/src/indexes/base-index.ts:52
Parameters#
n#
number
from#
TKey
filterFn?#
(key) => boolean
Returns#
TKey[]
takeReversedFromEnd()#
takeReversedFromEnd: (n, filterFn?) => TKey[];
Defined in: packages/db/src/indexes/base-index.ts:57
Parameters#
n#
number
filterFn?#
(key) => boolean
Returns#
TKey[]
update()#
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#
get indexedKeysSet(): Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:66
Returns#
Set<TKey>
keyCount#
Get Signature#
get keyCount(): number;
Defined in: packages/db/src/indexes/base-index.ts:62
Returns#
number
orderedEntriesArray#
Get Signature#
get orderedEntriesArray(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/base-index.ts:63
Returns#
[any, Set<TKey>][]
orderedEntriesArrayReversed#
Get Signature#
get orderedEntriesArrayReversed(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/base-index.ts:64
Returns#
[any, Set<TKey>][]
supportsRangeOptimization#
Get Signature#
get supportsRangeOptimization(): boolean;
Defined in: packages/db/src/indexes/base-index.ts:78
Whether range lookups (gt/gte/lt/lte) on this index can be trusted to
return every matching key. Range traversal relies on the index ordering, so
it is unsafe when the index uses a custom comparator, whose order may not
match the WHERE evaluator's relational operators. Callers must fall back to
a full scan when this is false.
Returns#
boolean
valueMapData#
Get Signature#
get valueMapData(): Map<any, Set<TKey>>;
Defined in: packages/db/src/indexes/base-index.ts:67
Returns#
Map<any, Set<TKey>>