Class OINODbSqlLimit

Class for limiting the number of results.

Index

Constructors

Methods

isEmpty toSql parse

Constructors

constructor

new OINODbSqlLimit(limit, page?): OINODbSqlLimit
Constructor for OINODbSqlLimit.
Parameters
- limit: number
  maximum number of items to return
- page: number = -1
  page number to return starting from 1
Returns OINODbSqlLimit
- Defined in db/src/OINODbSqlParams.ts:300

Methods

isEmpty

isEmpty(): boolean
Does filter contain any valid conditions.

Returns boolean
- Defined in db/src/OINODbSqlParams.ts:330

toSql

toSql(dataModel): string
Print order as SQL condition based on the datamodel of the API.
Parameters
- dataModel: OINODbDataModel
  data model (and database) to use for formatting of values
Returns string
- Defined in db/src/OINODbSqlParams.ts:340

`Static` parse

parse(limitString): OINODbSqlLimit
Constructor for OINODbSqlLimit as parser of http parameter.

Supports limit and page formatted as:
- limit - limit number of items to return
- limit page n - limit number of items to return and return page n (starting from 1)
- limit.n - limit number of items to return and return page n (starting from 1)
Parameters
- limitString: string
  string representation of limit from HTTP-request
Returns OINODbSqlLimit
- Defined in db/src/OINODbSqlParams.ts:315