WayrApp Backend & Ecosystem Documentation - v1.0.0
    Preparing search index...

    Interface PaginationOptions

    Configuration options for the pagination middleware.

    PaginationOptions

    interface PaginationOptions {
        defaultLimit?: number;
        maxLimit?: number;
        allowedSortFields?: string[];
        allowedFilters?: string[];
        defaultSortField?: string;
        searchFields?: string[];
    }
    Index

    Properties

    defaultLimit? maxLimit? allowedSortFields? allowedFilters? defaultSortField? searchFields?

    Properties

    defaultLimit?: number

    Default number of items per page when not specified in query parameters

    maxLimit?: number

    Maximum allowed limit to prevent excessive data retrieval

    allowedSortFields?: string[]

    Array of field names that are allowed for sorting operations

    allowedFilters?: string[]

    Array of filter parameter names that are allowed in query parameters

    defaultSortField?: string

    Default field to sort by when sortBy is not specified or invalid

    searchFields?: string[]

    Array of field names to search within when search parameter is provided

    Settings

    Member Visibility

    On This Page

    Properties