PageToken
Defined in: packages/aip/src/pagination/pagetoken.ts:31
PageToken is a page token that uses an offset to delineate which page to fetch.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PageToken(
offset,requestChecksum):PageToken
Defined in: packages/aip/src/pagination/pagetoken.ts:42
Parameters
Section titled “Parameters”offset
Section titled “offset”number
requestChecksum
Section titled “requestChecksum”number
Returns
Section titled “Returns”PageToken
Properties
Section titled “Properties”offset
Section titled “offset”offset:
number
Defined in: packages/aip/src/pagination/pagetoken.ts:35
Offset of the page.
requestChecksum
Section titled “requestChecksum”requestChecksum:
number
Defined in: packages/aip/src/pagination/pagetoken.ts:40
RequestChecksum is the checksum of the request that generated the page token.
Methods
Section titled “Methods”next()
Section titled “next()”next(
pageSize):PageToken
Defined in: packages/aip/src/pagination/pagetoken.ts:52
Returns the next page token for the given page size.
Parameters
Section titled “Parameters”pageSize
Section titled “pageSize”number
the page size to advance by
Returns
Section titled “Returns”PageToken
previous()
Section titled “previous()”previous(
pageSize):PageToken
Defined in: packages/aip/src/pagination/pagetoken.ts:64
Returns the previous page token for the given page size.
If the previous page token would have a negative offset, a page token with offset 0 will be returned.
Parameters
Section titled “Parameters”pageSize
Section titled “pageSize”number
the page size to go back by
Returns
Section titled “Returns”PageToken
toString()
Section titled “toString()”toString():
string
Defined in: packages/aip/src/pagination/pagetoken.ts:71
String returns a string representation of the page token.
Returns
Section titled “Returns”string