amocrm-client/dist/api/ResourcePagination.d.ts

JS Library for AmoCRM

import { IClientRequest } from "../common/ClientRequest";
import { IPaginatedResponse, IPaginationLinks, IResourceEntity, IResourceFactory, IResourcePagination, IResourcePaginationParams } from "../interfaces/api";
import { ResourceCollection } from "./ResourceCollection";
/**
 * Постраничная навигация вывода сущностей
 * */
export default class ResourcePagination<T extends IResourceEntity<IResourceFactory<T>>> implements IResourcePagination<T> {
    protected readonly request: IClientRequest;
    protected readonly params: IResourcePaginationParams<T>;
    protected data: T[];
    protected links: IPaginationLinks;
    protected page: number;
    constructor(request: IClientRequest, params: IResourcePaginationParams<T>);
    /**
     * Загружает данные первой страницы
     * */
    fetch(): Promise<T[]>;
    /**
     * Обновляет данные на текущей странице
     * */
    refresh(): Promise<false | T[]>;
    /**
     * Делает запрос на получение данных по заданному адресу
     * @param url адрес запроса
     * */
    protected fetchUrl(url: string): Promise<T[]>;
    /**
     * @returns есть ли следующая страница
     * */
    hasNext(): boolean;
    /**
     * @returns есть ли возможность загрузки первой страницы
     * */
    hasFirst(): boolean;
    /**
     * @returns есть ли предыдущая страница
     * */
    hasPrev(): boolean;
    /**
     * Загружает данные следующей страницы, если это возможно
     * */
    next(): Promise<false | T[]>;
    /**
     * Загружает данные первой страницы, если это возможно
     * */
    first(): Promise<false | T[]>;
    /**
     * Загружает данные предыдущей страницы, если это возможно
     * */
    prev(): Promise<false | T[]>;
    /**
     * Обрабатывает объект ссылок на первую, предыдущую и следущие страницы
     * */
    protected parseLinks(response?: IPaginatedResponse): this;
    /**
     * Преобразовывает массив атрибутов сущностей в объекты-сущностей
     * */
    protected parseData(response?: IPaginatedResponse): never[] | this | undefined;
    /**
     * Возвращает номер текущей страницы
     * */
    getPage(): number;
    /**
     * Возвращает массив сущностей на текущей странице
     * */
    getData(): ResourceCollection<T>;
}