Type Alias ListOptions

Options for one page of record IDs from Index.listPaginated.

type ListOptions = {
    limit?: number;
    namespace?: string;
    paginationToken?: string;
    prefix?: string;
}

Properties

limit?: number

Maximum IDs per page; omit for the service default. IDs are returned in sorted order.

namespace?: string

The namespace to list from. If not specified, uses the namespace configured on the Index.

paginationToken?: string

A token needed to fetch the next page of results. This token is returned in the response if additional results are available.

prefix?: string

The id prefix to match. If unspecified, an empty string prefix will be used with the effect of listing all ids in a namespace.