Defined in: packages/db/src/indexes/base-index.ts:58
Type Parameters#
TKey#
TKey extends string | number = string | number
Properties#
add()#
add: (key, item) => void;
Defined in: packages/db/src/indexes/base-index.ts:61
Parameters#
key#
TKey
item#
any
Returns#
void
build()#
build: (entries) => void;
Defined in: packages/db/src/indexes/base-index.ts:65
Parameters#
entries#
Iterable<[TKey, any]>
Returns#
void
canOptimizeRangeFor()?#
optional canOptimizeRangeFor: (value) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:109
Whether the live values in this index share the predicate operand's relational domain. Mixed domains can sort differently in the index and WHERE evaluator, which can make a range lookup omit matching rows.
Parameters#
value#
unknown
Returns#
boolean
clear()#
clear: () => void;
Defined in: packages/db/src/indexes/base-index.ts:66
Returns#
void
equalityLookup()#
equalityLookup: (value) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:70
Parameters#
value#
any
Returns#
Set<TKey>
inArrayLookup()#
inArrayLookup: (values) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:71
Parameters#
values#
any[]
Returns#
Set<TKey>
lookup()#
lookup: (operation, value) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:68
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:112
Parameters#
compareOptions#
CompareOptions
Returns#
boolean
matchesDirection()#
matchesDirection: (direction) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:113
Parameters#
direction#
Returns#
boolean
matchesField()#
matchesField: (fieldPath) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:111
Parameters#
fieldPath#
string[]
Returns#
boolean
rangeQuery()#
rangeQuery: (options) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:73
Parameters#
options#
Returns#
Set<TKey>
rangeQueryReversed()#
rangeQueryReversed: (options) => Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:74
Parameters#
options#
Returns#
Set<TKey>
remove()#
remove: (key, item) => void;
Defined in: packages/db/src/indexes/base-index.ts:62
Parameters#
key#
TKey
item#
any
Returns#
void
supports()#
supports: (operation) => boolean;
Defined in: packages/db/src/indexes/base-index.ts:93
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:76
Parameters#
n#
number
from#
unknown
filterFn?#
(key) => boolean
Returns#
TKey[]
takeFromStart()#
takeFromStart: (n, filterFn?) => TKey[];
Defined in: packages/db/src/indexes/base-index.ts:81
Parameters#
n#
number
filterFn?#
(key) => boolean
Returns#
TKey[]
takeReversed()#
takeReversed: (n, from, filterFn?) => TKey[];
Defined in: packages/db/src/indexes/base-index.ts:82
Parameters#
n#
number
from#
unknown
filterFn?#
(key) => boolean
Returns#
TKey[]
takeReversedFromEnd()#
takeReversedFromEnd: (n, filterFn?) => TKey[];
Defined in: packages/db/src/indexes/base-index.ts:87
Parameters#
n#
number
filterFn?#
(key) => boolean
Returns#
TKey[]
update()#
update: (key, oldItem, newItem) => void;
Defined in: packages/db/src/indexes/base-index.ts:63
Parameters#
key#
TKey
oldItem#
any
newItem#
any
Returns#
void
Accessors#
keyCount#
Get Signature#
get keyCount(): number;
Defined in: packages/db/src/indexes/base-index.ts:92
Returns#
number
supportsRangeOptimization#
Get Signature#
get supportsRangeOptimization(): boolean;
Defined in: packages/db/src/indexes/base-index.ts:102
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