Class Collection<T>

Collection is a group of instances sharing a schema. Collections are like db tables. They can only exist in a db.

Type parameters

T = unknown

Hierarchy

Collection

Index

Constructors

constructor

Accessors

name

Methods

Constructors

constructor

new Collection(table: Table<T, string>): Collection

- Defined in local/collection.ts:53
Parameters
- table: Table<T, string>
Returns Collection

Accessors

name

get name(): string

- Defined in local/collection.ts:62
A name for the collection.

Returns string

Methods

clear

clear(): Promise<boolean>

- Defined in local/collection.ts:69
Delete all instances in the collection.

Returns Promise<boolean>

count

count(query?: Query<Document<T>>): Promise<number>

- Defined in local/collection.ts:202
Count all instances matching the query.

note

This is not available on the Go API.

Parameters
- Optional query: Query<Document<T>>
  
  Mongodb-style filter query.
Returns Promise<number>

create

create(data?: T): Document<T> & Instance

- Defined in local/collection.ts:133
Create a new instance document that can be added or operated on. This does not automatically commit the instance to the collection.

Parameters
- Optional data: T
  
  The input data to use when initializing the document.
Returns Document<T> & Instance

delete

delete(...ids: string[]): Promise<void>

- Defined in local/collection.ts:145
Remove (multiple) instance(s) by id.

note

It doesn't fail if the ID doesn't exist.

Parameters
- Rest ...ids: string[]
  
  A variadic array of instance ids.
Returns Promise<void>

find

find(query?: Query<Document<T> & Instance>): Result<Document<T> & Instance, string>

- Defined in local/collection.ts:173
Find all instances matching the query.

Parameters
- Optional query: Query<Document<T> & Instance>
  
  Mongodb-style filter query.
Returns Result<Document<T> & Instance, string>

findById

findById(id: string): PromiseExtended<(Document<T> & Instance) | undefined>

- Defined in local/collection.ts:111
Find an instance by id.

Parameters
- id: string
  
  The instance id.
Returns PromiseExtended<(Document<T> & Instance) | undefined>

findOne

findOne(query?: Query<Document<T> & Instance>): Promise<(Document<T> & Instance) | undefined>

- Defined in local/collection.ts:186
Find the first instance matching the query

note

This is not available on the Go API.

Parameters
- Optional query: Query<Document<T> & Instance>
  
  Mongodb-style filter query.
Returns Promise<(Document<T> & Instance) | undefined>

has

has(...ids: string[]): Promise<boolean>

- Defined in local/collection.ts:163
Check that (all) instance(s) exists.

Parameters
- Rest ...ids: string[]
Returns Promise<boolean>

insert

insert(...instances: T[]): Promise<string[]>

- Defined in local/collection.ts:124
Insert (multiple) new instance(s).

note

Insert is similar to save, except it will not allow saving/overwriting existing instances.

note

This is the same as create on the Go API.

Parameters
- Rest ...instances: T[]
  
  A variadic array of instances.
Returns Promise<string[]>

readTransaction

readTransaction<T>(cb: T): ReturnType<T>

- Defined in local/collection.ts:83
Lock the collection for readonly operations.

note

Provides no serialize-able isolation guarantees.

note

In practice, this will return a readonly Collection, which disables write operations.

Type parameters
- T: (...args: any) => any
Parameters
- cb: T
  
  A callback that takes a readonly collection.
Returns ReturnType<T>

save

save(...instances: T[]): Promise<string[]>

- Defined in local/collection.ts:155
Save updates to (multiple) instance(s).

note

Save is similar to insert, except it allows saving/overwriting existing instances.

Parameters
- Rest ...instances: T[]
  
  A variadic array of instances.
Returns Promise<string[]>

writeTransaction

writeTransaction<T>(cb: T): ReturnType<T>

- Defined in local/collection.ts:99
Lock the collection for exclusive write operations.

note

Provides no serialize-able isolation guarantees.

Type parameters
- T: (...args: any) => any
Parameters
- cb: T
  
  A callback that takes a collection.
Returns ReturnType<T>