Interface Collection

interface Collection {
    add(data: DocumentContentWithOptionalId): { _id: string };
    count(): number;
    doc(id: string): Document;
    get(): DocumentContentWithId[];
    limit(limit: number): Collection;
    orderBy(field: string, order?: OrderType): Collection;
    remove(): void;
    removeById(id: string): void;
    skip(skip: number): Collection;
    update(update: JSONUpdate): void;
    where(conditions: WhereConditions): Collection;
}

Index

Methods

add count doc get limit orderBy remove removeById skip update where

Methods

add

add(data: DocumentContentWithOptionalId): { _id: string }
Uses _id if provided; otherwise generates one.

This operation is transactional: if it throws, nothing changes.
Parameters
- data: DocumentContentWithOptionalId
Returns { _id: string }
Throws
- DocumentAlreadyExistsError: If _id already exists.
- Defined in src/types/collection.ts:51

count

count(): number
Returns number
- Defined in src/types/collection.ts:73

doc

doc(id: string): Document
Parameters
- id: string
Returns Document
Throws
- DocumentNotExistsError: If the document does not exist.
- Defined in src/types/collection.ts:57

get

get(): DocumentContentWithId[]
Returns DocumentContentWithId[]
Throws
- IncomparableValueError: If sorting encounters values that cannot be compared.
- Defined in src/types/collection.ts:79

limit

limit(limit: number): Collection
Parameters
- limit: number
Returns Collection
- Defined in src/types/collection.ts:61

orderBy

orderBy(field: string, order?: OrderType): Collection
Sorting currently supports only string and number values. Multiple calls accumulate sort rules in order.
Parameters
- field: string
- Optionalorder: OrderType
  defaults to "asc"
Returns Collection
- Defined in src/types/collection.ts:71

remove

remove(): void
Returns void
- Defined in src/types/collection.ts:88

removeById

removeById(id: string): void
Parameters
- id: string
Returns void
- Defined in src/types/collection.ts:90

skip

skip(skip: number): Collection
Parameters
- skip: number
Returns Collection
- Defined in src/types/collection.ts:63

update

update(update: JSONUpdate): void
This operation is transactional: if it throws, nothing changes.
Parameters
- update: JSONUpdate
Returns void
Throws
Propagates errors thrown by JSONObjectOps.update.
- Defined in src/types/collection.ts:86

where

where(conditions: WhereConditions): Collection
Parameters
- conditions: WhereConditions
Returns Collection
- Defined in src/types/collection.ts:59