Class Query

An object used to filter input documents

Param: condition

The condition for constructing predicates

Param: options

Options for use by operators

Index

Constructors

Methods

find remove test

Constructors

constructor

new Query(condition, options?): Query
Parameters
- condition: AnyObject
- Optionaloptions: Partial<Options>
Returns Query
- Defined in src/query.ts:32

Methods

find

find<T>(collection, projection?): Cursor<T>
Returns a cursor to select matching documents from the input source.
Type Parameters
- T
Parameters
- collection: Source
- Optionalprojection: AnyObject
  An optional projection criteria
Returns Cursor<T>
A Cursor for iterating over the results
- Defined in src/query.ts:112

remove

remove<T>(collection): T[]
Remove matched documents from the collection returning the remainder
Type Parameters
- T
Parameters
- collection: T[]
  An array of documents
Returns T[]
A new array with matching elements removed
- Defined in src/query.ts:127

test

test<T>(obj): boolean
Checks if the object passes the query criteria. Returns true if so, false otherwise.
Type Parameters
- T
Parameters
- obj: T
  The object to test
Returns boolean
True or false
- Defined in src/query.ts:96