/*!
 * @license
 * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
 */

import { AttributeValue } from '@aws-sdk/client-dynamodb';

/**
 * The response for a DynamoDB query for a paginated list of data.
 * @export
 * @interface PaginationQueryResponse
 */
export interface PaginationQueryResponse<T> {
  /**
   * The list of items that matched the query.
   * @type {Array<T>}
   * @memberof PaginationQueryResponse
   */
  items: Array<T>;

  /**
   * The last evaluated key of the query.
   * @type {Record<string, AttributeValue>}
   * @memberof PaginationQueryResponse
   */
  lastEvaluatedKey?: Record<string, AttributeValue>;
}