Class ConnectionsPagePagination

Page-based pagination metadata.

Hierarchy

  • ConnectionsPagePagination

Constructors

constructor

Properties

additionalProperties? firstNumber? firstOffset? lastNumber? lastOffset? limit? nextNumber? nextOffset? number? offset? prevNumber? prevOffset? size? total? type?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional firstNumber

firstNumber?: number

The first page number.

Optional firstOffset

firstOffset?: number

The first offset.

Optional lastNumber

lastNumber?: number

The last page number.

Optional lastOffset

lastOffset?: number

The last offset.

Optional limit

limit?: number

The page limit, when offset pagination is used.

Optional nextNumber

nextNumber?: number

The next page number.

Optional nextOffset

nextOffset?: number

The next offset.

Optional number

number?: number

The current page number.

Optional offset

offset?: number

The current offset, when offset pagination is used.

Optional prevNumber

prevNumber?: number

The previous page number.

Optional prevOffset

prevOffset?: number

The previous offset.

Optional size

size?: number

The page size.

Optional total

total?: number

Total connections matching request.

Optional type

type?: string

Pagination type.

Settings

Member Visibility

Theme

Generated using TypeDoc