Skip to content

parse

parse<T>(schema, request, pageTokenChecksumMask?): PageToken

Defined in: packages/aip/src/pagination/pagetoken.ts:88

Parses an offset-based page token from the provided Request.

If the request does not have a page token, a page token with offset 0 will be returned.

T extends string = string

DescMessage

the schema of the request

RequestMessage<T>

the request to parse the page token from

number = 0x9acb0442

a random bitmask applied to offset-based page token checksums. Change the bitmask to force checksum failures when changing the page token implementation.

PageToken