Skip to main content

Class: OffsetParams

Defined in: ts/src/params.ts:26

Offset pagination input: { page, limit } (defaults: page 1, limit 20).

Constructors​

Constructor​

new OffsetParams(__namedParameters?): OffsetParams

Defined in: ts/src/params.ts:30

Parameters​

__namedParameters?​
limit?​

number = 20

page?​

number = 1

Returns​

OffsetParams

Properties​

limit​

readonly limit: number

Defined in: ts/src/params.ts:28

page​

readonly page: number

Defined in: ts/src/params.ts:27

Accessors​

offset​

Get Signature​

get offset(): number

Defined in: ts/src/params.ts:40

Zero-based offset for database queries.

Returns​

number

Methods​

clamp()​

clamp(total): OffsetParams

Defined in: ts/src/params.ts:45

Return params with page clamped into [1, maxPage] for total rows.

Parameters​

total​

number

Returns​

OffsetParams