Class Query

Hierarchy

Query

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Query(runHandler?: function, data?: object): Query
new Query(runHandler?: function, data?: object): Query

- Defined in Query.ts:28
Parameters
- Optional runHandler: function
  - - (query: Query): Promise<RecordData[]>
    - Parameters
      - query: Query
      Returns Promise<RecordData[]>
- Optional data: object
Returns Query
- Defined in Query.d.ts:8
Parameters
- Optional runHandler: function
  - - (query: Query): Promise<RecordData[]>
    - Parameters
      - query: Query
      Returns Promise<RecordData[]>
- Optional data: object
Returns Query

Properties

data

data: any

runHandler

runHandler: function

Type declaration

- (query: object): Promise<RecordData[]>
- Parameters
  - query: object
  Returns Promise<RecordData[]>

Static COMPARISON_OPERATORS

COMPARISON_OPERATORS: string[] = ['$eq','$gt','$gte','$in','$lt','$lte','$ne','$nin']

Static ELEMENT_OPERATORS

ELEMENT_OPERATORS: string[] = ['$exists']

Static LOGIC_OPERATORS

LOGIC_OPERATORS: string[] = ['$and','$or']

Methods

add

add(key: string, operator?: string, value?: any, logicalOperator?: string): this
add(key: string, operator?: string, value?: any, logicalOperator?: string): this

- Defined in Query.ts:126
Parameters
- key: string
- Optional operator: string
- Optional value: any
- Optional logicalOperator: string
Returns this
- Defined in Query.d.ts:11
Parameters
- key: string
- Optional operator: string
- Optional value: any
- Optional logicalOperator: string
Returns this

and

and(key: string): WhereQuery
and(key: string): WhereQuery

- Defined in Query.ts:150
Parameters
- key: string
Returns WhereQuery
- Defined in Query.d.ts:12
Parameters
- key: string
Returns WhereQuery

fields

fields(...fields: (string | string[])[]): this
fields(...fields: (string | string[])[]): this

- Defined in Query.ts:154
Parameters
- Rest ...fields: (string | string[])[]
Returns this
- Defined in Query.d.ts:13
Parameters
- Rest ...fields: (string | string[])[]
Returns this

limit

limit(value: number): this
limit(value: number): this

- Defined in Query.ts:172
Parameters
- value: number
Returns this
- Defined in Query.d.ts:14
Parameters
- value: number
Returns this

or

or(key: string): WhereQuery
or(key: string): WhereQuery

- Defined in Query.ts:177
Parameters
- key: string
Returns WhereQuery
- Defined in Query.d.ts:15
Parameters
- key: string
Returns WhereQuery

run

run(): Promise<RecordData[]>
run(): Promise<RecordData[]>

- Defined in Query.ts:190
Returns Promise<RecordData[]>
- Defined in Query.d.ts:16
Returns Promise<RecordData[]>

skip

skip(value: number): this
skip(value: number): this

- Defined in Query.ts:194
Parameters
- value: number
Returns this
- Defined in Query.d.ts:17
Parameters
- value: number
Returns this

sort

sort(key: string | any[], order?: number): this
sort(key: string | any[], order?: number): this

- Defined in Query.ts:199
Parameters
- key: string | any[]
- Default value order: number = 1
Returns this
- Defined in Query.d.ts:18
Parameters
- key: string | any[]
- Optional order: number
Returns this

toJSON

toJSON(): any
toJSON(): any

- Defined in Query.ts:221
Returns any
- Defined in Query.d.ts:19
Returns any

where

where(key: string, operator?: string, value?: any, logicalOperator?: string): WhereQuery
where(key: string, operator?: string, value?: any, logicalOperator?: string): WhereQuery

- Defined in Query.ts:225
Parameters
- key: string
- Optional operator: string
- Optional value: any
- Optional logicalOperator: string
Returns WhereQuery
- Defined in Query.d.ts:20
Parameters
- key: string
- Optional operator: string
- Optional value: any
- Optional logicalOperator: string
Returns WhereQuery