AWS SDK Vitest Mock - API Reference - v1.0.93
    Preparing search index...

    Interface PaginatorOptions

    Configuration options for paginated responses.

    Tokens are automatically set to the last item of each page, which works for both DynamoDB-style pagination (object tokens) and S3-style pagination (object tokens).

    {
      pageSize: 10,
      tokenKey: "LastEvaluatedKey",      // DynamoDB response key
      inputTokenKey: "ExclusiveStartKey", // DynamoDB request key
      itemsKey: "Items"
    }

    {
      pageSize: 50,
      tokenKey: "NextContinuationToken",  // S3 response key
      inputTokenKey: "ContinuationToken",  // S3 request key
      itemsKey: "Contents"
    }
    interface PaginatorOptions {
        pageSize?: number;
        tokenKey?: string;
        inputTokenKey?: string;
        itemsKey?: string;
    }
    Index
    pageSize? tokenKey? inputTokenKey? itemsKey?
    pageSize?: number

    Number of items per page.

    10
    tokenKey?: string

    Property name for the pagination token in the response. The token will be set to the last item of the page.

    Common values:

    • DynamoDB: "LastEvaluatedKey"
    • S3: "NextContinuationToken"
    • Generic: "NextToken"
    "NextToken"
    inputTokenKey?: string

    Property name for the pagination token in the request. If not specified, uses the same value as tokenKey.

    Use this when the service uses different names for input and output tokens.

    Common values:

    • DynamoDB: "ExclusiveStartKey" (when tokenKey is "LastEvaluatedKey")
    • S3: "ContinuationToken" (when tokenKey is "NextContinuationToken")
    Same as tokenKey
    itemsKey?: string

    Property name for the items array in the response.

    Common values:

    • DynamoDB: "Items"
    • S3: "Contents"
    "Items"

    Settings
    Member Visibility

    On This Page
    Properties