Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Paginator<T>

Type parameters

  • T

Hierarchy

Implements

  • AsyncIterableIterator<Array<T>>

Index

Constructors

Protected constructor

  • new Paginator(paginator: DynamoDbPaginatorInterface, valueConstructor: ZeroArgumentsConstructor<T>): Paginator
  • Parameters

    • paginator: DynamoDbPaginatorInterface
    • valueConstructor: ZeroArgumentsConstructor<T>

    Returns Paginator

Accessors

consumedCapacity

  • get consumedCapacity(): ConsumedCapacity | undefined
  • Retrieve the reported capacity consumed by this paginator. Will be undefined unless returned consumed capacity is requested.

    Returns ConsumedCapacity | undefined

count

  • get count(): number
  • Retrieve the number of items yielded thus far by this paginator.

    Returns number

lastEvaluatedKey

  • get lastEvaluatedKey(): Partial<T> | undefined
  • Retrieve the last reported LastEvaluatedKey, unmarshalled according to the schema used by this paginator.

    Returns Partial<T> | undefined

scannedCount

  • get scannedCount(): number
  • Retrieve the number of items scanned thus far during the execution of this paginator. This number should be the same as count unless a filter expression was used.

    Returns number

Methods

__@asyncIterator

  • __@asyncIterator(): this

next

  • next(): Promise<IteratorResult<Array<T>>>
  • inheritdoc

    Returns Promise<IteratorResult<Array<T>>>

return

  • return(): Promise<IteratorResult<Array<T>>>
  • inheritdoc

    Returns Promise<IteratorResult<Array<T>>>