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

import { PaginationDirectionType, PaginationPageLimit } from './PaginationTypes';

/**
 * The pagination info for a request.
 * @interface PaginationInfo
 */
export interface PaginationInfo {
  /**
   * The pagination direction.
   * @type {PaginationDirectionType}
   * @memberof PaginationInfo
   */
  direction: PaginationDirectionType;

  /**
   * The pagination limit.
   * @type {PaginationPageLimit}
   * @memberof PaginationInfo
   */
  limit: PaginationPageLimit;

  /**
   * The request URL.
   * @type {string}
   * @memberof PaginationInfo
   */
  requestUrl: string;

  /**
   * The encoded token string.
   * @type {string | null}
   * @memberof PaginationInfo
   */
  token: string | null;
}