Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DynamoDbPaginator

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

Protected constructor

Accessors

consumedCapacity

  • get consumedCapacity(): ConsumedCapacity | undefined

  • The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.

    inheritdoc

    Returns ConsumedCapacity | undefined

count

  • get count(): number

lastEvaluatedKey

  • get lastEvaluatedKey(): Key | undefined

  • Get the LastEvaluatedKey of the last result page yielded by this paginator or undefined if the scan has already been exhausted.

    Returns Key | undefined

scannedCount

  • get scannedCount(): number

  • The number of items evaluated, before any ScanFilter is applied. A high scannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

    inheritdoc

    Returns number

Methods

__@asyncIterator

Protected Abstract getNext

Protected getNextPageSize

  • getNextPageSize(requestedPageSize?: undefined | number): number | undefined

  • Parameters

    • Optional requestedPageSize: undefined | number

    Returns number | undefined

next

return