Defined in: packages/db/src/types.ts:15
Interface for a collection-like object that provides the necessary methods for the change events system to work
Extends#
Pick<Collection<T,TKey>,"get"|"has"|"entries"|"indexes"|"id"|"compareOptions">
Type Parameters#
T#
T extends object = Record<string, unknown>
TKey#
TKey extends string | number = string | number
Properties#
compareOptions#
compareOptions: StringCollationConfig;
Defined in: packages/db/src/collection/index.ts:775
Inherited from#
id#
id: string;
Defined in: packages/db/src/collection/index.ts:341
Inherited from#
indexes#
indexes: Map<number, BaseIndex<TKey>>;
Defined in: packages/db/src/collection/index.ts:760
Inherited from#
Pick.indexes
Methods#
entries()#
entries(): IterableIterator<[TKey, WithVirtualProps<T, TKey>]>;
Defined in: packages/db/src/collection/index.ts:651
Get all entries (virtual derived state)
Returns#
IterableIterator<[TKey, WithVirtualProps<T, TKey>]>
Inherited from#
Pick.entries
get()#
get(key):
| WithVirtualProps<T, TKey>
| undefined;
Defined in: packages/db/src/collection/index.ts:611
Get the current value for a key (virtual derived state)
Parameters#
key#
TKey
Returns#
| WithVirtualProps<T, TKey>
| undefined
Inherited from#
Pick.get
has()#
has(key): boolean;
Defined in: packages/db/src/collection/index.ts:618
Check if a key exists in the collection (virtual derived state)
Parameters#
key#
TKey
Returns#
boolean
Inherited from#
Pick.has