Class Query<T>

Represents a query object used to filter and match documents based on specified criteria. All query, projection, and related expression operators are preloaded into the context by default.

Example

const query = new Query({ age: { $gt: 18 } });
const result = query.test({ name: "John", age: 25 }); // true

Type Parameters

T = AnyObject

Hierarchy (View Summary)

Query<T>
- Query

Index

Constructors

constructor

Methods

find test

Constructors

constructor

new Query<T = AnyObject>(
condition: Criteria<T>,
options?: Partial<Options>,
): Query<T>
Type Parameters
- T = AnyObject
Parameters
- condition: Criteria<T>
- Optionaloptions: Partial<Options>
Returns Query<T>
Overrides Query.constructor
- Defined in src/index.ts:35

Methods

find

find<R>(collection: Source, projection?: Projection<R>): Cursor<R>
Returns a cursor for iterating over the items in the given collection that match the query criteria.
Type Parameters
- R
Parameters
- collection: Source
  The source collection to search through.
- Optionalprojection: Projection<R>
  An optional object specifying fields to include or exclude in the returned items.
Returns Cursor<R>
A Cursor instance for iterating over the matching items.
Inherited from Query.find
- Defined in src/query.ts:114

test

test(obj: T): boolean
Tests whether the given object satisfies all compiled predicates.
Parameters
- obj: T
  The object to be tested against the compiled predicates.
Returns boolean
true if the object satisfies all predicates, otherwise false.
Inherited from Query.test
- Defined in src/query.ts:101

Class Query<T>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Query<T>

Methods

find

Type Parameters

Parameters

Returns Cursor<R>

test

Parameters

Returns boolean

Settings

On This Page