Interface PaginatedResponse<ItemType>

A standard response from a paginated endpoint

interface PaginatedResponse {
    count: number;
    nextToken: null | string;
    previousToken: null | string;
    total: number;
    value: ItemType[];
}

Type Parameters

  • ItemType

Properties

count nextToken previousToken total value

Properties

count

count: number

The amount of items on this page

nextToken

nextToken: null | string

Token to fetch the next page of results

previousToken

previousToken: null | string

Token to fetch the next page of results

total

total: number

The total number of items in the DB

value

value: ItemType[]

The current page of items

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc