Interface CollectionInterface

interface CollectionInterface {
    name: string;
    find(query, queryArgs?): BasePendingCursorOperation;
    findAll(): BasePendingCursorOperation;
    findByID(id): BasePendingIDSpecificOperation;
    upsert(value, options): Promise<DocumentID>;
}

Implemented by

Index

Properties

Methods

find findAll findByID upsert

Properties

`Readonly` name

name: string

The name of the collection.

Methods

find

find(query, queryArgs?): BasePendingCursorOperation
Search for documents in this collection using the provided query string.
Parameters
- query: string
  The query to run against the collection.
- Optional queryArgs: QueryArguments
  These arguments replace placeholders in the provided query.
Returns BasePendingCursorOperation

findAll

findAll(): BasePendingCursorOperation
Convenience method, equivalent to calling find() and passing the query "true".

Returns BasePendingCursorOperation

findByID

findByID(id): BasePendingIDSpecificOperation
Find documents given a specific ID.

Use the returned cursor instance to chain operations on the search result.
Parameters
- id: any
  The document's identifier
Returns BasePendingIDSpecificOperation

upsert

upsert(value, options): Promise<DocumentID>
Inserts a new document into the collection and returns its ID.

If the document already exists, the contents of both are merged by default. You can change this by providing a different writeStrategy via options.
Parameters
- value: DocumentValue
  The content of the document to be inserted or updated. Must not contain any non-finite numbers (NaN, Infinity, -Infinity).
- options: UpsertOptions
  Change defaults for the behavior of the operation, such as the write strategy.
Returns Promise<DocumentID>