Class Operator<T>

An Operator saves the state of a combined query

Type Parameters

T extends Entity

Hierarchy

Node<T>
- Operator

Index

Constructors

constructor

new Operator<T>(entityManager: EntityManager, resultClass: Class<T>, operator: string, childes: Node<T>[]): Operator<T>
Type Parameters
- T extends Entity<T>
Parameters
- entityManager: EntityManager
  
  The owning entity manager of this query
- resultClass: Class<T>
  
  The query result class
- operator: string
  
  The operator used to join the childes
- childes: Node<T>[]
  
  The childes to join
Returns Operator<T>
Overrides Node.constructor
- Defined in lib/query/Operator.ts:26

Properties

`Readonly` childes

childes: Node<T>[]

The child Node of this query, it is always one

`Readonly` entityManager

entityManager: EntityManager

The owning EntityManager of this query

firstResult

firstResult: number = 0

The offset how many results should be skipped

`Readonly` maxResults

maxResults: number = -1

The limit how many objects should be returned

`Readonly` operator

operator: string

The operator used to join the child queries

order

order: {
[field: string]: 1 | -1;
} = {}

The properties which should be used sort the result

Type declaration

[field: string]: 1 | -1

`Readonly` resultClass

resultClass: Class<T>

The result class of this query

`Static` `Readonly` MAX_URI_SIZE

MAX_URI_SIZE: 2000 = 2000

Methods

addLimit

addLimit(limit: number): Operator<T>
Parameters
- limit: number
Returns Operator<T>
Inherited from Node.addLimit
- Defined in lib/query/Node.ts:178

addOffset

addOffset(offset: number): Operator<T>
Parameters
- offset: number
Returns Operator<T>
Inherited from Node.addOffset
- Defined in lib/query/Node.ts:173

addOrder

addOrder(fieldOrSort: string | {
[field: string]: 1 | -1;
}, order?: 1 | -1): Operator<T>
Parameters
- fieldOrSort: string | {
  [field: string]: 1 | -1;
  }
- Optional order: 1 | -1
Returns Operator<T>
Inherited from Node.addOrder
- Defined in lib/query/Node.ts:164

ascending

ascending(field: string): Node<T>
Add an ascending sort for the specified field to this query

Returns
The resulting Query
Parameters
- field: string
  
  The field to sort
Returns Node<T>
Inherited from Node.ascending
- Defined in lib/query/Query.ts:27

count

count(doneCallback?: CountCallback, failCallback?: FailCallback): Promise<any>
Execute the query that returns the matching objects count.

Returns
The total number of matched objects
Parameters
- Optional doneCallback: CountCallback
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when there is a server-side error
Returns Promise<any>
Inherited from Node.count
- Defined in lib/query/Node.ts:106

descending

descending(field: string): Node<T>
Add an decending sort for the specified field to this query

Returns
The resulting Query
Parameters
- field: string
  
  The field to sort
Returns Node<T>
Inherited from Node.descending
- Defined in lib/query/Query.ts:36

limit

limit(limit: number): Node<T>
Sets the limit of this query, i.e hox many objects should be returnd

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/method/cursor.limit/
Parameters
- limit: number
  
  The limit of this query
Returns Node<T>
Inherited from Node.limit
- Defined in lib/query/Query.ts:78

offset

offset(offset: number): Node<T>
Sets the offset of the query, i.e. how many elements should be skipped

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/method/cursor.skip/
Parameters
- offset: number
  
  The offset of this query
Returns Node<T>
Inherited from Node.offset
- Defined in lib/query/Query.ts:63

resultList

resultList(options?: ResultOptions | ResultListCallback<T>, doneCallback?: FailCallback | ResultListCallback<T>, failCallback?: FailCallback): Promise<T[]>
Execute the query and return the query results as a List

Note: All local unsaved changes on matching objects, will be discarded.

Returns
A promise that will be resolved with the query result as a list
Parameters
- Optional options: ResultOptions | ResultListCallback<T>
  
  The query options
- Optional doneCallback: FailCallback | ResultListCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<T[]>
Inherited from Node.resultList
- Defined in lib/query/Node.ts:40

singleResult

singleResult(options?: ResultOptions | SingleResultCallback<T>, doneCallback?: FailCallback | SingleResultCallback<T>, failCallback?: FailCallback): Promise<null | T>
Execute the query that returns a single result

Note: All local unsaved changes on the matched object, will be discarded.

Returns
A promise that will be resolved with the query result as a single result
Parameters
- Optional options: ResultOptions | SingleResultCallback<T>
  
  The query options
- Optional doneCallback: FailCallback | SingleResultCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<null | T>
Inherited from Node.singleResult
- Defined in lib/query/Node.ts:73

sort

sort(sort: {
[field: string]: 1 | -1;
}): Node<T>
Sets the sort of the query and discard all existing paramaters

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/method/cursor.sort/
Parameters
- sort: {
  [field: string]: 1 | -1;
  }
  
  The new sort of the query which is an object whose keys are fields and the values are either +1 for ascending order or -1 for descending order
  - [field: string]: 1 | -1
Returns Node<T>
Inherited from Node.sort
- Defined in lib/query/Query.ts:48

toJSON

toJSON(): {
[operator: string]: Node<T>[];
}
Returns {
[operator: string]: Node<T>[];
}
- [operator: string]: Node<T>[]
- Defined in lib/query/Operator.ts:32

Class Operator<T>

Type Parameters

T extends Entity

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends Entity<T>

Parameters

entityManager: EntityManager

resultClass: Class<T>

operator: string

childes: Node<T>[]

Returns Operator<T>

Properties

Readonly childes

Readonly entityManager

firstResult

Readonly maxResults

Readonly operator

order

Type declaration

[field: string]: 1 | -1

Readonly resultClass

Static Readonly MAX_URI_SIZE

Methods

addLimit

Parameters

limit: number

Returns Operator<T>

addOffset

Parameters

offset: number

Returns Operator<T>

addOrder

Parameters

fieldOrSort: string | { [field: string]: 1 | -1; }

Optional order: 1 | -1

Returns Operator<T>

ascending

Returns

Parameters

field: string

Returns Node<T>

count

Returns

Parameters

Optional doneCallback: CountCallback

Optional failCallback: FailCallback

Returns Promise<any>

descending

Returns

Parameters

field: string

Returns Node<T>

limit

Returns

See

Parameters

limit: number

Returns Node<T>

offset

Returns

See

Parameters

offset: number

Returns Node<T>

resultList

Returns

Parameters

Optional options: ResultOptions | ResultListCallback<T>

Optional doneCallback: FailCallback | ResultListCallback<T>

Optional failCallback: FailCallback

Returns Promise<T[]>

singleResult

Returns

`Readonly` childes

`Readonly` entityManager

`Readonly` maxResults

`Readonly` operator

`Readonly` resultClass

`Static` `Readonly` MAX_URI_SIZE

fieldOrSort: string | {
[field: string]: 1 | -1;
}

`Optional` order: 1 | -1

`Optional` doneCallback: CountCallback

`Optional` failCallback: FailCallback

`Optional` options: ResultOptions | ResultListCallback<T>

`Optional` doneCallback: FailCallback | ResultListCallback<T>

`Optional` failCallback: FailCallback

`Optional` options: ResultOptions | SingleResultCallback<T>

`Optional` doneCallback: FailCallback | SingleResultCallback<T>

`Optional` failCallback: FailCallback

sort: {
[field: string]: 1 | -1;
}

Returns {
[operator: string]: Node<T>[];
}