Class KiiQuery

Represents a KiiQuery object

Hierarchy

KiiQuery

Index

Methods

Methods

getLimit

getLimit(): number

- Defined in src/query.ts:43
Get the limit of the current query

Returns number

setLimit

setLimit(limit: number): void

- Defined in src/query.ts:51
setLimit

Parameters
- limit: number
  
  The desired limit. Must be an integer > 0
Returns void

sortByAsc

sortByAsc(field: string): void

- Defined in src/query.ts:111
Set the query to sort by a field in ascending order If a sort has already been set, it will be overwritten.

Parameters
- field: string
  
  The key that should be used to sort
Returns void

sortByDesc

sortByDesc(field: string): void

- Defined in src/query.ts:101
Set the query to sort by a field in descending order If a sort has already been set, it will be overwritten.

Parameters
- field: string
  
  The key that should be used to sort
Returns void

Static queryWithClause

queryWithClause(clause: null | KiiClause): KiiQuery

- Defined in src/query.ts:86
Create a KiiQuery object based on a KiiClause

By passing null as the ‘clause’ parameter, all objects can be retrieved.

Parameters
- clause: null | KiiClause
  
  The KiiClause to be executed with the query
Returns KiiQuery

Generated using TypeDoc