Class LocalCollection<T>

Type Parameters

T extends Document = Document

Index

Constructors

Methods

batch deleteMany deleteOne execute find findOne insert insertOne onChange remove updateMany updateOne upsert

Constructors

constructor

new LocalCollection<T extends Document = Document>(
initial?: readonly T[],
): LocalCollection<T>
Type Parameters
- T extends Document = Document
Parameters
- initial: readonly T[] = []
Returns LocalCollection<T>
- Defined in sdk/client/src/local.ts:52

Methods

batch

batch(action: () => void): void
Parameters
- action: () => void
Returns void
- Defined in sdk/client/src/local.ts:101

deleteMany

deleteMany(filter: Filter): DeleteResult
Parameters
- filter: Filter
Returns DeleteResult
- Defined in sdk/client/src/local.ts:99

deleteOne

deleteOne(filter: Filter): DeleteResult
Parameters
- filter: Filter
Returns DeleteResult
- Defined in sdk/client/src/local.ts:98

execute

execute(spec: QuerySpec): T[]
Parameters
- spec: QuerySpec
Returns T[]
- Defined in sdk/client/src/local.ts:109

find

find(filter?: Filter, options?: QueryOptions): LiveQuery<T>
Parameters
- filter: Filter = {}
- options: QueryOptions = {}
Returns LiveQuery<T>
- Defined in sdk/client/src/local.ts:87

findOne

findOne(filter?: Filter, options?: FindOneOptions): T | undefined
Parameters
- filter: Filter = {}
- options: FindOneOptions = {}
Returns T | undefined
- Defined in sdk/client/src/local.ts:91

insert

insert(document: T): void
Parameters
- document: T
Returns void
- Defined in sdk/client/src/local.ts:56

insertOne

insertOne(document: InputDocument): T
Parameters
- document: InputDocument
Returns T
- Defined in sdk/client/src/local.ts:64

onChange

onChange(listener: () => void): Unsubscribe
Parameters
- listener: () => void
Returns Unsubscribe
- Defined in sdk/client/src/local.ts:113

remove

remove(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in sdk/client/src/local.ts:80

updateMany

updateMany(filter: Filter, update: Update): MutationResult
Parameters
- filter: Filter
- update: Update
Returns MutationResult
- Defined in sdk/client/src/local.ts:97

updateOne

updateOne(filter: Filter, update: Update): MutationResult
Parameters
- filter: Filter
- update: Update
Returns MutationResult
- Defined in sdk/client/src/local.ts:96

upsert

upsert(document: T): void
Create or fully replace one local document addressed by its _id.
Parameters
- document: T
Returns void
- Defined in sdk/client/src/local.ts:73