routier-collection / datastore/src / Collection

Class: Collection<TEntity, TStore>

Defined in: datastore/src/collections/Collection.ts:7

Extends

RemovableCollection<TEntity, TStore>

Type Parameters

TEntity

TEntity extends object

TStore

TStore = unknown

Constructors

Constructor

new Collection<TEntity, TStore>(dependencies): Collection<TEntity, TStore>

Defined in: datastore/src/collections/Collection.ts:13

Parameters

dependencies

CollectionDependencies<TEntity>

Returns

Collection<TEntity, TStore>

Overrides

RemovableCollection<TEntity, TStore>.constructor

Properties

attachments

attachments: object

Defined in: datastore/src/collections/Collection.ts:48

remove()

remove: (...entities) => InferType<TEntity>[]

Detaches entities from change tracking, removing them from the collection's managed set

Parameters

entities

...InferType<TEntity>[]

Returns

InferType<TEntity>[]

set()

set: (...entities) => InferType<TEntity>[]

Attaches entities to change tracking, enabling property change monitoring and dirty state management. The given instances become the canonical attachments — an explicit set means the caller will mutate THESE instances, so a previously attached copy of the same entity (e.g. via a background query) is merged into them and replaced rather than kept.

Parameters

entities

...InferType<TEntity>[]

Returns

InferType<TEntity>[]

has()

has: (entity) => boolean

Checks if an entity is currently attached to change tracking

Parameters

entity

InferType<TEntity>

Returns

boolean

get()

get: (entity) => InferType<TEntity>

Retrieves an attached entity from change tracking if it exists

Parameters

entity

InferType<TEntity>

Returns

InferType<TEntity>

filter()

filter: (selector) => InferType<TEntity>[]

Filters attached entities using a selector function, returning entities that match the criteria

Parameters

selector

GenericFunction<InferType<TEntity>, boolean>

Returns

InferType<TEntity>[]

find()

find: (selector) => InferType<TEntity>

Finds attached entity using a selector function, returning first entity that matches the criteria

Parameters

selector

GenericFunction<InferType<TEntity>, boolean>

Returns

InferType<TEntity>

markDirty()

markDirty: (...entities) => void

Marks entities as dirty, forcing them to be included in the next save operation regardless of actual property changes

Parameters

entities

...InferType<TEntity>[]

Returns

void

getChangeType()

getChangeType: (entity) => EntityChangeType

Retrieves the change type for a specific entity. Returns the change type if attached, or undefined if not attached.

Parameters

entity

InferType<TEntity>

Returns

EntityChangeType

fullTextSearch

fullTextSearch: object

Defined in: datastore/src/collections/CollectionBase.ts:40

Operating the collection's search index — declared with .fullTextSearch() on the builder, operated here.

const drift = await store.articles.fullTextSearch.check();
if (drift.isHealthy === false) await store.articles.fullTextSearch.rebuild();

Both throw on a collection that never declared an index, rather than reporting a healthy index that does not exist.

check()

check: () => Promise<{ missing: number; extra: number; stale: number; get isHealthy(): boolean; }>

What is wrong with the index, changing nothing.

A scheduled job should call this before rebuild: a repair that silently fixes drift also hides whatever caused it.

Returns

Promise<{ missing: number; extra: number; stale: number; get isHealthy(): boolean; }>

rebuild()

rebuild: () => Promise<{ added: number; updated: number; removed: number; }>

Makes the index match the documents, writing only the differences.

Idempotent and safe to run on a schedule. Reads every document, so it belongs in a scheduled job rather than on a request path.

Returns

Promise<{ added: number; updated: number; removed: number; }>

Inherited from

RemovableCollection.fullTextSearch

Accessors

schema

Get Signature

get schema(): CompiledSchema<TEntity>

Defined in: datastore/src/collections/CollectionBase.ts:24

Returns

CompiledSchema<TEntity>

Inherited from

RemovableCollection.schema

Methods

add()

add(entities, done): void

Defined in: datastore/src/collections/Collection.ts:105

Adds entities to the collection and persists them to the database.

Parameters

entities

InferCreateType<TEntity>[]

Array of entities to add to the collection

done

CallbackResult<InferType<TEntity>[]>

Callback function called with the added entities or error

Returns

void

addAsync()

addAsync(...entities): Promise<InferType<TEntity>[]>

Defined in: datastore/src/collections/Collection.ts:115

Adds entities to the collection asynchronously and returns a Promise.

Parameters

entities

...InferCreateType<TEntity>[]

Entities to add to the collection

Returns

Promise<InferType<TEntity>[]>

Promise that resolves with the added entities or rejects with an error

tag()

tag(tag): Collection<TEntity, TStore>

Defined in: datastore/src/collections/Collection.ts:124

Sets a tag for the next operation. The tag will be used to group related operations.

Parameters

tag

unknown

The tag to associate with the next operation

Returns

Collection<TEntity, TStore>

The collection instance for method chaining

search()

Call Signature

search(terms, options?): SearchQueryable<TEntity>

Defined in: datastore/src/collections/CollectionBase.ts:78

Ranked full-text search over the properties marked .searchable().

const hits = await store.articles
    .search('copper pipe')
    .where(x => x.published === true)
    .take(10)
    .toArrayAsync();

const loose = await store.articles
    .search(x => x.body, 'copper pipe', { match: 'any' })
    .toArrayAsync();

Results carry a readonly score and are ordered by it, then by key. map() drops the score; sort() replaces the ranking. Requires .fullTextSearch() on the collection.

Parameters

terms

string

options?

SearchOptions

Returns

SearchQueryable<TEntity>

Inherited from

RemovableCollection.search

Call Signature

search(selector, terms, options?): SearchQueryable<TEntity>

Defined in: datastore/src/collections/CollectionBase.ts:79

Ranked full-text search over the properties marked .searchable().

const hits = await store.articles
    .search('copper pipe')
    .where(x => x.published === true)
    .take(10)
    .toArrayAsync();

const loose = await store.articles
    .search(x => x.body, 'copper pipe', { match: 'any' })
    .toArrayAsync();

Results carry a readonly score and are ordered by it, then by key. map() drops the score; sort() replaces the ranking. Requires .fullTextSearch() on the collection.

Parameters

selector

GenericFunction<InferType<TEntity>, string>

terms

string

options?

SearchOptions

Returns

SearchQueryable<TEntity>

Inherited from

RemovableCollection.search

Call Signature

search(selectors, terms, options?): SearchQueryable<TEntity>

Defined in: datastore/src/collections/CollectionBase.ts:80

Ranked full-text search over the properties marked .searchable().

const hits = await store.articles
    .search('copper pipe')
    .where(x => x.published === true)
    .take(10)
    .toArrayAsync();

const loose = await store.articles
    .search(x => x.body, 'copper pipe', { match: 'any' })
    .toArrayAsync();

Results carry a readonly score and are ordered by it, then by key. map() drops the score; sort() replaces the ranking. Requires .fullTextSearch() on the collection.

Parameters

selectors

GenericFunction<InferType<TEntity>, string>[]

terms

string

options?

SearchOptions

Returns

SearchQueryable<TEntity>

Inherited from

RemovableCollection.search

[dispose]()

[dispose](): void

Defined in: datastore/src/collections/CollectionBase.ts:162

Returns

void

Inherited from

RemovableCollection.[dispose]

[inspectionQueryable]()

[inspectionQueryable](): QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:166

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Inherited from

RemovableCollection.[inspectionQueryable]

dispose()

dispose(): void

Defined in: datastore/src/collections/CollectionBase.ts:171

Returns

void

Inherited from

RemovableCollection.dispose

update()

update(entity, recipe): any

Defined in: datastore/src/collections/CollectionBase.ts:334

Applies a patch — or an updater function — to a row, returning the new value.

SPIKE (specs/immutable-updates.md). The immutable alternative to mutating a change-tracked proxy. Two things make it different from entity.price = 9:

It returns the new value; it does not modify the one you passed.
Your reference only has to identify the row, not be current. The patch is applied to whatever the collection holds now, so handing it a stale entity is safe — which is the failure mode that actually loses data. It also makes read-modify-write correct, because the updater receives the current value:

// +2, as intended. With a stale `prev` captured by the caller this would be +1.
store.products.update(p, prev => ({ ...prev, price: prev.price + 1 }));
store.products.update(p, prev => ({ ...prev, price: prev.price + 1 }));

Arrays and Dates are values: a patch replaces them rather than merging into them. That is deliberate — element-wise array merging makes "drop the last tag" inexpressible, and it is the ambiguity that made in-place array mutation unreliable under proxies (defect #12).

Parameters

entity

InferType<TEntity>

Any generation of the row. Only its id is read.

recipe

A partial entity to merge, or current => next.

Record<string, any> | (current) => InferType<TEntity>

Returns

any

Inherited from

RemovableCollection.update

current()

current(entity): InferType<TEntity>

Defined in: datastore/src/collections/CollectionBase.ts:344

The current value of a row, given any generation of it.

The escape hatch for imperative code holding a reference across updates. Component code should not need it — subscriptions hand out fresh values on every change.

Parameters

entity

InferType<TEntity>

Returns

InferType<TEntity>

Inherited from

RemovableCollection.current

isCurrent()

isCurrent(entity): boolean

Defined in: datastore/src/collections/CollectionBase.ts:349

Whether the given reference is the row's current value.

Parameters

entity

InferType<TEntity>

Returns

boolean

Inherited from

RemovableCollection.isCurrent

hasChanges()

hasChanges(): boolean

Defined in: datastore/src/collections/CollectionBase.ts:364

Returns

boolean

Inherited from

RemovableCollection.hasChanges

instance()

instance(...entities): InferCreateType<TEntity>[]

Defined in: datastore/src/collections/CollectionBase.ts:373

Creates change-tracked instances of entities without adding them to the collection.

Parameters

entities

...InferCreateType<TEntity>[]

Entities to create change-tracked instances for

Returns

InferCreateType<TEntity>[]

Array of change-tracked entity instances

Inherited from

RemovableCollection.instance

subscribe(): SubscribedQueryable<TEntity, InferType<TEntity>, () => void>

Defined in: datastore/src/collections/CollectionBase.ts:388

Creates a subscription to the collection that will be notified of changes.

Returns

SubscribedQueryable<TEntity, InferType<TEntity>, () => void>

A subscription object that can be used to listen for collection changes

Inherited from

RemovableCollection.subscribe

joinSide()

joinSide(): JoinSide<TEntity>

Defined in: datastore/src/collections/CollectionBase.ts:406

What this collection looks like as the INNER side of someone else's join.

Public because a join is written from the other collection — players.join(matches, …) — and matches has to hand over three things it otherwise keeps to itself. Read JoinSide for why each is needed; the short version is that the scoped options are the ONLY place the inner side's soft-delete and .scope() filters exist once a join bypasses its read path.

Views implement this by extending this class, which is a requirement rather than a convenience: full-text search joins its index view to its source collection.

Returns

JoinSide<TEntity>

Inherited from

RemovableCollection.joinSide

join()

join<TInner, TKey>(inner, outerKey, innerKey): JoinQueryable<TEntity, JoinTuple<InferType<TEntity>, InferType<TInner>>, false>

Defined in: datastore/src/collections/CollectionBase.ts:427

Pairs each row with every matching row of inner — an inner equi-join. See QueryableExecutor.setJoinQueryOption.

store.players
    .join(s => s.playerMatches, p => p._id, m => m.playerId)
    .toArrayAsync();

s is this store, so a sibling collection is named once. Pass a collection directly to join across two stores — see JoinTarget.

Type Parameters

TInner

TInner extends object

TKey

TKey extends string | number

Parameters

inner

JoinTarget<TStore, TInner>

outerKey

(outer) => TKey

innerKey

(inner) => TKey

Returns

JoinQueryable<TEntity, JoinTuple<InferType<TEntity>, InferType<TInner>>, false>

Inherited from

RemovableCollection.join

explain()

explain(): QueryableAsync<TEntity, InferType<TEntity>, TStore, true>

Defined in: datastore/src/collections/CollectionBase.ts:444

Reports where each query option ran — the database or memory — alongside the results.

See QueryableAsync.explain. Starts a query the same way where does, so the whole collection can be explained without filtering it first.

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, true>

Inherited from

RemovableCollection.explain

leftJoin()

leftJoin<TInner, TKey>(inner, outerKey, innerKey): JoinQueryable<TEntity, JoinTuple<InferType<TEntity>, InferType<TInner>>, false>

Defined in: datastore/src/collections/CollectionBase.ts:451

Like join, but unmatched rows appear paired with undefined.

Type Parameters

TInner

TInner extends object

TKey

TKey extends string | number

Parameters

inner

JoinTarget<TStore, TInner>

outerKey

(outer) => TKey

innerKey

(inner) => TKey

Returns

JoinQueryable<TEntity, JoinTuple<InferType<TEntity>, InferType<TInner>>, false>

Inherited from

RemovableCollection.leftJoin

groupJoin()

groupJoin<TInner, TKey>(inner, outerKey, innerKey): JoinQueryable<TEntity, JoinTuple<InferType<TEntity>, InferType<TInner>[]>, false>

Defined in: datastore/src/collections/CollectionBase.ts:462

Type Parameters

TInner

TInner extends object

TKey

TKey extends string | number

Parameters

inner

JoinTarget<TStore, TInner>

outerKey

(outer) => TKey

innerKey

(inner) => TKey

Returns

JoinQueryable<TEntity, JoinTuple<InferType<TEntity>, InferType<TInner>[]>, false>

Inherited from

RemovableCollection.groupJoin

where()

Call Signature

where(expression): QueryableAsync<TEntity, InferType<TEntity>, TStore>

Defined in: datastore/src/collections/CollectionBase.ts:478

Creates a query with a filter expression to filter entities in the collection.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply to the collection

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.where

Call Signature

where<P>(selector, params): QueryableAsync<TEntity, InferType<TEntity>, TStore>

Defined in: datastore/src/collections/CollectionBase.ts:485

Creates a query with a parameterized filter to filter entities in the collection.

Type Parameters

P

P extends object

Parameters

selector

ParamsFilter<InferType<TEntity>, P>

Parameterized filter function

params

P

Parameters to pass to the filter function

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.where

sort()

sort(selector): QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:503

Sorts the collection by the specified property in ascending order.

Parameters

selector

EntityMap<InferType<TEntity>, InferType<TEntity>[keyof InferType<TEntity>]>

Function that selects the property to sort by

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.sort

sortDescending()

sortDescending(selector): QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:514

Sorts the collection by the specified property in descending order.

Parameters

selector

EntityMap<InferType<TEntity>, InferType<TEntity>[keyof InferType<TEntity>]>

Function that selects the property to sort by

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.sortDescending

nearest()

nearest(selector, vector, count): QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:528

The count entities whose vector is most similar to vector, nearest first.

Parameters

selector

EntityMap<InferType<TEntity>, InferType<TEntity>[keyof InferType<TEntity>]>

Function that selects the vector property to search

vector

number[]

The embedding to compare against, of the property's declared width

count

number

How many entities to return

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.nearest

toGroup()

toGroup<R>(selector, done): void

Defined in: datastore/src/collections/CollectionBase.ts:535

Type Parameters

R

R extends string | number

Parameters

selector

GenericFunction<InferType<TEntity>, R>

done

CallbackResult<Record<R, InferType<TEntity>[]>>

Returns

void

Inherited from

RemovableCollection.toGroup

toGroupAsync()

toGroupAsync<R>(selector): Promise<Record<R, InferType<TEntity>[]>>

Defined in: datastore/src/collections/CollectionBase.ts:541

Type Parameters

R

R extends string | number

Parameters

selector

GenericFunction<InferType<TEntity>, R>

Returns

Promise<Record<R, InferType<TEntity>[]>>

Inherited from

RemovableCollection.toGroupAsync

map()

map<R>(expression): QueryableAsync<TEntity, R, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:550

Maps the collection to a new shape using the specified transformation function.

Type Parameters

R

R

Parameters

expression

EntityMap<InferType<TEntity>, R>

Function that transforms each entity to the new shape

Returns

QueryableAsync<TEntity, R, TStore, false>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.map

skip()

skip(amount): QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:561

Skips the specified number of entities in the collection.

Parameters

amount

number

Number of entities to skip

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.skip

take()

take(amount): QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:572

Takes the specified number of entities from the collection.

Parameters

amount

number

Number of entities to take

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.take

toQueryable()

toQueryable(): QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:583

Converts the collection to a QueryableAsync instance for building queries dynamically. This is useful when you need to conditionally build queries by chaining operations based on logic.

Returns

QueryableAsync<TEntity, InferType<TEntity>, TStore, false>

QueryableAsync instance for chaining additional query operations

Inherited from

RemovableCollection.toQueryable

apply()

apply<U, Shape>(composer): QueryableAsync<TEntity, Shape, TStore, false>

Defined in: datastore/src/collections/CollectionBase.ts:588

Type Parameters

U

U

Shape

Shape

Parameters

composer

QueryableBuilder<TEntity, Shape, U>

Returns

QueryableAsync<TEntity, Shape, TStore, false>

Inherited from

RemovableCollection.apply

toArray()

toArray(done): void

Defined in: datastore/src/collections/CollectionBase.ts:597

Executes the query and returns all results as an array.

Parameters

done

CallbackResult<InferType<TEntity>[]>

Callback function called with the array of entities or error

Returns

void

Inherited from

RemovableCollection.toArray

toArrayAsync()

toArrayAsync(): Promise<InferType<TEntity>[]>

Defined in: datastore/src/collections/CollectionBase.ts:607

Executes the query asynchronously and returns all results as an array.

Returns

Promise<InferType<TEntity>[]>

Promise that resolves with the array of entities or rejects with an error

Inherited from

RemovableCollection.toArrayAsync

first()

Call Signature

first(expression, done): void

Defined in: datastore/src/collections/CollectionBase.ts:618

Returns the first entity that matches the filter expression.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

done

CallbackResult<InferType<TEntity>>

Callback function called with the first matching entity or error

Returns

void

Inherited from

RemovableCollection.first

Call Signature

first<P>(expression, params, done): void

Defined in: datastore/src/collections/CollectionBase.ts:625

Returns the first entity that matches the parameterized filter.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

params

P

Parameters to pass to the filter function

done

CallbackResult<InferType<TEntity>>

Callback function called with the first matching entity or error

Returns

void

Inherited from

RemovableCollection.first

Call Signature

first(done): void

Defined in: datastore/src/collections/CollectionBase.ts:630

Returns the first entity in the collection.

Parameters

done

CallbackResult<InferType<TEntity>>

Callback function called with the first entity or error

Returns

void

Inherited from

RemovableCollection.first

firstAsync()

Call Signature

firstAsync(expression): Promise<InferType<TEntity>>

Defined in: datastore/src/collections/CollectionBase.ts:657

Returns the first entity that matches the filter expression asynchronously.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

Returns

Promise<InferType<TEntity>>

Promise that resolves with the first matching entity or rejects with an error

Inherited from

RemovableCollection.firstAsync

Call Signature

firstAsync<P>(expression, params): Promise<InferType<TEntity>>

Defined in: datastore/src/collections/CollectionBase.ts:664

Returns the first entity that matches the parameterized filter asynchronously.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

params

P

Parameters to pass to the filter function

Returns

Promise<InferType<TEntity>>

Promise that resolves with the first matching entity or rejects with an error

Inherited from

RemovableCollection.firstAsync

Call Signature

firstAsync(): Promise<InferType<TEntity>>

Defined in: datastore/src/collections/CollectionBase.ts:669

Returns the first entity in the collection asynchronously.

Returns

Promise<InferType<TEntity>>

Promise that resolves with the first entity or rejects with an error

Inherited from

RemovableCollection.firstAsync

firstOrUndefined()

Call Signature

firstOrUndefined(expression, done): void

Defined in: datastore/src/collections/CollectionBase.ts:693

Returns the first entity that matches the filter expression, or undefined if none found.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

done

CallbackResult<InferType<TEntity>>

Callback function called with the first matching entity, undefined, or error

Returns

void

Inherited from

RemovableCollection.firstOrUndefined

Call Signature

firstOrUndefined<P>(expression, params, done): void

Defined in: datastore/src/collections/CollectionBase.ts:700

Returns the first entity that matches the parameterized filter, or undefined if none found.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

params

P

Parameters to pass to the filter function

done

CallbackResult<InferType<TEntity>>

Callback function called with the first matching entity, undefined, or error

Returns

void

Inherited from

RemovableCollection.firstOrUndefined

Call Signature

firstOrUndefined(done): void

Defined in: datastore/src/collections/CollectionBase.ts:705

Returns the first entity in the collection, or undefined if empty.

Parameters

done

CallbackResult<InferType<TEntity>>

Callback function called with the first entity, undefined, or error

Returns

void

Inherited from

RemovableCollection.firstOrUndefined

firstOrUndefinedAsync()

Call Signature

firstOrUndefinedAsync(expression): Promise<InferType<TEntity>>

Defined in: datastore/src/collections/CollectionBase.ts:732

Returns the first entity that matches the filter expression asynchronously, or undefined if none found.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

Returns

Promise<InferType<TEntity>>

Promise that resolves with the first matching entity, undefined, or rejects with an error

Inherited from

RemovableCollection.firstOrUndefinedAsync

Call Signature

firstOrUndefinedAsync<P>(expression, params): Promise<InferType<TEntity>>

Defined in: datastore/src/collections/CollectionBase.ts:739

Returns the first entity that matches the parameterized filter asynchronously, or undefined if none found.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

params

P

Parameters to pass to the filter function

Returns

Promise<InferType<TEntity>>

Promise that resolves with the first matching entity, undefined, or rejects with an error

Inherited from

RemovableCollection.firstOrUndefinedAsync

Call Signature

firstOrUndefinedAsync(): Promise<InferType<TEntity>>

Defined in: datastore/src/collections/CollectionBase.ts:744

Returns the first entity in the collection asynchronously, or undefined if empty.

Returns

Promise<InferType<TEntity>>

Promise that resolves with the first entity, undefined, or rejects with an error

Inherited from

RemovableCollection.firstOrUndefinedAsync

some()

Call Signature

some(expression, done): void

Defined in: datastore/src/collections/CollectionBase.ts:769

Checks if any entity matches the filter expression.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

done

CallbackResult<boolean>

Callback function called with true if any entity matches, false otherwise, or error

Returns

void

Inherited from

RemovableCollection.some

Call Signature

some<P>(expression, params, done): void

Defined in: datastore/src/collections/CollectionBase.ts:776

Checks if any entity matches the parameterized filter.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

params

P

Parameters to pass to the filter function

done

CallbackResult<boolean>

Callback function called with true if any entity matches, false otherwise, or error

Returns

void

Inherited from

RemovableCollection.some

Call Signature

some(done): void

Defined in: datastore/src/collections/CollectionBase.ts:781

Checks if the collection has any entities.

Parameters

done

CallbackResult<boolean>

Callback function called with true if collection has entities, false otherwise, or error

Returns

void

Inherited from

RemovableCollection.some

someAsync()

Call Signature

someAsync(expression): Promise<boolean>

Defined in: datastore/src/collections/CollectionBase.ts:809

Checks if any entity matches the filter expression asynchronously.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

Returns

Promise<boolean>

Promise that resolves with true if any entity matches, false otherwise, or rejects with an error

Inherited from

RemovableCollection.someAsync

Call Signature

someAsync<P>(expression, params): Promise<boolean>

Defined in: datastore/src/collections/CollectionBase.ts:816

Checks if any entity matches the parameterized filter asynchronously.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

params

P

Parameters to pass to the filter function

Returns

Promise<boolean>

Promise that resolves with true if any entity matches, false otherwise, or rejects with an error

Inherited from

RemovableCollection.someAsync

Call Signature

someAsync(): Promise<boolean>

Defined in: datastore/src/collections/CollectionBase.ts:821

Checks if the collection has any entities asynchronously.

Returns

Promise<boolean>

Promise that resolves with true if collection has entities, false otherwise, or rejects with an error

Inherited from

RemovableCollection.someAsync

every()

Call Signature

every(expression, done): void

Defined in: datastore/src/collections/CollectionBase.ts:846

Checks if all entities match the filter expression.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

done

CallbackResult<boolean>

Callback function called with true if all entities match, false otherwise, or error

Returns

void

Inherited from

RemovableCollection.every

Call Signature

every(expression, done): void

Defined in: datastore/src/collections/CollectionBase.ts:853

Checks if all entities match the parameterized filter.

Parameters

expression

Filter<InferType<TEntity>>

done

CallbackResult<boolean>

Callback function called with true if all entities match, false otherwise, or error

Returns

void

Inherited from

RemovableCollection.every

Call Signature

every<P>(expression, params, done): void

Defined in: datastore/src/collections/CollectionBase.ts:854

Checks if all entities match the filter expression.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

Filter expression to apply

params

P

done

CallbackResult<boolean>

Callback function called with true if all entities match, false otherwise, or error

Returns

void

Inherited from

RemovableCollection.every

everyAsync()

Call Signature

everyAsync(expression): Promise<boolean>

Defined in: datastore/src/collections/CollectionBase.ts:877

Checks if all entities match the filter expression asynchronously.

Parameters

expression

Filter<InferType<TEntity>>

Filter expression to apply

Returns

Promise<boolean>

Promise that resolves with true if all entities match, false otherwise, or rejects with an error

Inherited from

RemovableCollection.everyAsync

Call Signature

everyAsync(expression): Promise<boolean>

Defined in: datastore/src/collections/CollectionBase.ts:884

Checks if all entities match the parameterized filter asynchronously.

Parameters

expression

Filter<InferType<TEntity>>

Returns

Promise<boolean>

Promise that resolves with true if all entities match, false otherwise, or rejects with an error

Inherited from

RemovableCollection.everyAsync

Call Signature

everyAsync<P>(expression, params): Promise<boolean>

Defined in: datastore/src/collections/CollectionBase.ts:885

Checks if all entities match the filter expression asynchronously.

Type Parameters

P

P extends object

Parameters

expression

ParamsFilter<InferType<TEntity>, P>

Filter expression to apply

params

P

Returns

Promise<boolean>

Promise that resolves with true if all entities match, false otherwise, or rejects with an error

Inherited from

RemovableCollection.everyAsync

min()

min(selector, done): void

Defined in: datastore/src/collections/CollectionBase.ts:906

Finds the minimum value of the specified numeric property across all entities.

Parameters

selector

GenericFunction<InferType<TEntity>, number>

Function that selects the numeric property to find the minimum of

done

CallbackResult<number>

Callback function called with the minimum value or error

Returns

void

Inherited from

RemovableCollection.min

minAsync()

minAsync(selector): Promise<number>

Defined in: datastore/src/collections/CollectionBase.ts:919

Finds the minimum value of the specified numeric property across all entities asynchronously.

Parameters

selector

GenericFunction<InferType<TEntity>, number>

Function that selects the numeric property to find the minimum of

Returns

Promise<number>

Promise that resolves with the minimum value or rejects with an error

Inherited from

RemovableCollection.minAsync

max()

max(selector, done): void

Defined in: datastore/src/collections/CollectionBase.ts:932

Finds the maximum value of the specified numeric property across all entities.

Parameters

selector

GenericFunction<InferType<TEntity>, number>

Function that selects the numeric property to find the maximum of

done

CallbackResult<number>

Callback function called with the maximum value or error

Returns

void

Inherited from

RemovableCollection.max

maxAsync()

maxAsync(selector): Promise<number>

Defined in: datastore/src/collections/CollectionBase.ts:945

Finds the maximum value of the specified numeric property across all entities asynchronously.

Parameters

selector

GenericFunction<InferType<TEntity>, number>

Function that selects the numeric property to find the maximum of

Returns

Promise<number>

Promise that resolves with the maximum value or rejects with an error

Inherited from

RemovableCollection.maxAsync

sum()

sum(selector, done): void

Defined in: datastore/src/collections/CollectionBase.ts:958

Calculates the sum of the specified numeric property across all entities.

Parameters

selector

GenericFunction<InferType<TEntity>, number>

Function that selects the numeric property to sum

done

CallbackResult<number>

Callback function called with the sum or error

Returns

void

Inherited from

RemovableCollection.sum

sumAsync()

sumAsync(selector): Promise<number>

Defined in: datastore/src/collections/CollectionBase.ts:971

Calculates the sum of the specified numeric property across all entities asynchronously.

Parameters

selector

GenericFunction<InferType<TEntity>, number>

Function that selects the numeric property to sum

Returns

Promise<number>

Promise that resolves with the sum or rejects with an error

Inherited from

RemovableCollection.sumAsync

count()

count(done): void

Defined in: datastore/src/collections/CollectionBase.ts:983

Counts the number of entities in the collection.

Parameters

done

CallbackResult<number>

Callback function called with the count or error

Returns

void

Inherited from

RemovableCollection.count

countAsync()

countAsync(): Promise<number>

Defined in: datastore/src/collections/CollectionBase.ts:995

Counts the number of entities in the collection asynchronously.

Returns

Promise<number>

Promise that resolves with the count or rejects with an error

Inherited from

RemovableCollection.countAsync

distinct()

distinct(done): void

Defined in: datastore/src/collections/CollectionBase.ts:1007

Returns distinct entities from the collection, removing duplicates.

Parameters

done

CallbackResult<InferType<TEntity>[]>

Callback function called with the distinct entities or error

Returns

void

Inherited from

RemovableCollection.distinct

distinctAsync()

distinctAsync(): Promise<InferType<TEntity>[]>

Defined in: datastore/src/collections/CollectionBase.ts:1019

Returns distinct entities from the collection asynchronously, removing duplicates.

Returns

Promise<InferType<TEntity>[]>

Promise that resolves with the distinct entities or rejects with an error

Inherited from

RemovableCollection.distinctAsync

remove()

remove(entities, done): void

Defined in: datastore/src/collections/RemovableCollection.ts:26

Removes entities from the collection and persists the changes to the database.

Parameters

entities

InferType<TEntity>[]

Array of entities to remove from the collection

done

CallbackResult<InferType<TEntity>[]>

Callback function called with the removed entities or error

Returns

void

Inherited from

RemovableCollection.remove

removeAsync()

removeAsync(...entities): Promise<InferType<TEntity>[]>

Defined in: datastore/src/collections/RemovableCollection.ts:36

Removes entities from the collection asynchronously and returns a Promise.

Parameters

entities

...InferType<TEntity>[]

Entities to remove from the collection

Returns

Promise<InferType<TEntity>[]>

Promise that resolves with the removed entities or rejects with an error

Inherited from

RemovableCollection.removeAsync

removeAll()

removeAll(done): void

Defined in: datastore/src/collections/RemovableCollection.ts:46

Removes all entities from the collection and persists the changes to the database.

Parameters

done

CallbackResult<InferType<TEntity>[]>

Callback function called when the operation completes or with an error

Returns

void

Inherited from

RemovableCollection.removeAll

removeAllAsync()

removeAllAsync(): Promise<InferType<TEntity>[]>

Defined in: datastore/src/collections/RemovableCollection.ts:56

Removes all entities from the collection asynchronously and returns a Promise.

Returns

Promise<InferType<TEntity>[]>

Promise that resolves when the operation completes or rejects with an error

Inherited from

RemovableCollection.removeAllAsync

Class: Collection<TEntity, TStore> ​

Extends ​

Type Parameters ​

TEntity ​

TStore ​

Constructors ​

Constructor ​

Parameters ​

dependencies ​

Returns ​

Overrides ​

Properties ​

tags ​

get() ​

Returns ​

destroy() ​

Returns ​

attachments ​

remove() ​

Parameters ​

entities ​

Returns ​

set() ​

Parameters ​

entities ​

Returns ​

has() ​

Parameters ​

entity ​

Returns ​

get() ​

Parameters ​

entity ​

Returns ​

filter() ​

Parameters ​

selector ​

Returns ​

find() ​

Parameters ​

selector ​

Returns ​

markDirty() ​

Parameters ​

entities ​

Returns ​

getChangeType() ​

Parameters ​

entity ​

Returns ​

fullTextSearch ​

check() ​

Returns ​

rebuild() ​

Returns ​

Inherited from ​

Accessors ​

schema ​

Get Signature ​

Returns ​

Inherited from ​

Methods ​

add() ​

Parameters ​

entities ​

done ​

Returns ​

addAsync() ​

Parameters ​

entities ​

Returns ​

tag() ​

Parameters ​

tag ​

Returns ​

search() ​

Call Signature ​

Parameters ​

terms ​

options? ​

Class: Collection<TEntity, TStore>

Extends

Type Parameters

TEntity

TStore

Constructors

Constructor

Parameters

dependencies

Returns

Overrides

Properties

tags

get()

Returns

destroy()

Returns

attachments

remove()

Parameters

entities

Returns

set()

Parameters

entities

Returns

has()

Parameters

entity

Returns

get()

Parameters

entity

Returns

filter()

Parameters

selector

Returns

find()

Parameters

selector

Returns

markDirty()

Parameters

entities

Returns

getChangeType()

Parameters

entity

Returns

fullTextSearch

check()

Returns

rebuild()

Returns

Inherited from

Accessors

schema

Get Signature

Returns

Inherited from

Methods

add()

Parameters

entities

done

Returns

addAsync()

Parameters

entities

Returns

tag()

Parameters

tag

Returns

search()

Call Signature

Parameters

terms

options?