PagedMetadata

Table of contents

1. Description
2. Properties
3. @Example

---

Description

A common object which is contained inside a paginated response. It holds metadata related to the requested pages.

Note: The index page starts from 0.

Properties

Field	Type	Description
page	number	Currently looked page
pageSize	number	Describes how much entities are present per page
totalPages	number	Total number of pages for the given page size
totalResultsCount	number	Total results entities accross all pages

@Example

const pagedResponseMetadata = {
    page: 0,
    pageSize: 100,
    totalPages: 1,
    totalResultsCount: 20
}