Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryPaginator<T>

Iterates over each page of items returned by a DynamoDB query until no more pages are available.

Type parameters

  • T

Hierarchy

Implements

  • AsyncIterableIterator<Array<T>>

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new QueryPaginator(client: DynamoDB, valueConstructor: ZeroArgumentsConstructor<T>, keyCondition: ConditionExpression | object, options?: QueryOptions & object): QueryPaginator

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

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>>>

return

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