@mantlebee/ts-data
    Preparing search index...

    Class PaginationExtension<TItem>

    Reads the total count with its own reader on every read, then adds the Pagination to the payload. Place it after the extensions whose contribution the count must consider (filters above all). The count reader receives the signal of the read, so it can hand it to fetch. By default it goes back to the first page when the query built by the previous extensions changes between two reads (PaginationExtensionOptions.resetPageOnQueryChange).

    const countUsers = (payload, signal) => api.countUsers(payload, { signal });
    const pagination = new PaginationExtension<User>(countUsers, 20, [10, 20, 50]);
    const dataSource = createDataSource(readUsers, { filtering, pagination });
    pagination.on("page", () => dataSource.read());
    await dataSource.read(); // countUsers(payload) then readUsers({ ..., pagination: { page: 1, itemsPerPage: 20, totalItemsCount } })
    pagination.goToNextPage(); // page event (if there is a second page), hence a new read

    Type Parameters

    • TItem = Any

      Type of the items.

    Hierarchy (View Summary)

    Implements

    Index
    constructor
    _changeDelay _eventBus _itemsPerPage _itemsPerPageOptions? _page _resetPageOnQueryChange _totalCountReader _totalItemsCount
    _pagination canGoNextPage canGoPreviousPage itemsPerPage itemsPerPageOptions lastPage page totalItemsCount
    _scheduleChange _triggerChange buildPayload dispose goToFirstPage goToLastPage goToNextPage goToPage goToPreviousPage on setItemsPerPage

    Protected Readonly_changeDelay

    _changeDelay: number

    Protected_eventBus

    _eventBus: EventBus<PaginationExtensionEvents>

    Bus used to register handlers and to raise the events.

    Protected_itemsPerPage

    _itemsPerPage: number

    Protected Optional Readonly_itemsPerPageOptions

    _itemsPerPageOptions?: List<number>

    Protected_page

    _page: number = 1

    Protected Readonly_resetPageOnQueryChange

    _resetPageOnQueryChange: boolean | List<keyof DataSourcePayload<TItem>>

    Protected Readonly_totalCountReader

    _totalCountReader: DataSourceReader<TItem, number>

    Protected_totalItemsCount

    _totalItemsCount: number = 0

    Protected_pagination

    page

    Protected_scheduleChange

    Protected_triggerChange

    • Registers a handler for an event.

      Type Parameters

      • TKey extends string

        Name of the event to listen to.

      Parameters

      Returns IDisposable

      a subscription; dispose it to remove this single handler.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods