tezx/middleware/pagination.d.ts

TezX is a modern, ultra-lightweight, and high-performance JavaScript framework built specifically for Bun. It provides a minimal yet powerful API, seamless environment management, and a high-concurrency HTTP engine for building fast, scalable web applicat

import { Context } from "../index.js";
export type PaginationOptions<DataKey extends string = "data", CountKey extends string = "total", Item = any> = {
    /**
     * 🔢 Default page number when not specified
     * @default 1
     * @example 1 // Start from first page
     */
    defaultPage?: number;
    /**
     * 📏 Default items per page
     * @default 10
     * @example 25 // Show 25 items by default
     */
    defaultLimit?: number;
    /**
     * ⚠️ Maximum allowed items per page
     * @default 100
     * @example 50 // Never return more than 50 items
     */
    maxLimit?: number;
    /**
     * 🔍 Query parameter name for page number
     * @default "page"
     * @example "p" // Use ?p=2 instead of ?page=2
     */
    queryKeyPage?: string;
    /**
     * 🔍 Query parameter name for items limit
     * @default "limit"
     * @example "size" // Use ?size=20
     */
    queryKeyLimit?: string;
    /**
     * 📊 Key to read total count from response
     * @default "total"
     * @example "totalCount" // Read from response.totalCount
     */
    countKey?: CountKey;
    /**
     * 📦 Key containing the data array in response
     * @default "data"
     * @example "items" // Process response.items array
     */
    dataKey?: DataKey;
    /**
     * 🛠️ Function to fetch data dynamically
     * @param ctx - Request context
     * @param pagination - Pagination details
     * @returns Promise with data and total count
     * @example
     * getDataSource: async (ctx, { page, limit }) => {
     *   return db.find().skip((page-1)*limit).limit(limit);
     * }
     */
    getDataSource?: <T extends Record<string, any> = {}>(ctx: Context<T>, pagination: {
        page: number;
        limit: number;
        offset: number;
    }) => Promise<{
        [K in DataKey]: Item[];
    } & {
        [K in CountKey]: number;
    }>;
};
export type PaginationBodyType = {
    [x: string]: any;
    pagination: {
        page: number;
        limit: number;
        totalItems: any;
        offset: number;
        totalPages: number;
        hasNextPage: boolean;
        hasPrevPage: boolean;
        nextPage: number | null;
        prevPage: number | null;
    };
};
/**
 * 🗂️ Advanced pagination middleware with dynamic data fetching
 *
 * Features:
 * - Automatic pagination parameter handling
 * - Dynamic data source integration
 * - Comprehensive pagination metadata
 * - Built-in error handling
 *
 * @param {PaginationOptions} [options={}] - Configuration options for pagination behavior
 * @returns {Callback} Middleware function that processes pagination and sets response
 *
 * @example
 * // Basic usage
 * app.get('/users', paginationHandler());
 *
 * // With dynamic data source
 * app.get('/products', paginationHandler({
 *   getDataSource: async (ctx, { page, limit }) => {
 *     return await Product.findAndCountAll({
 *       offset: (page-1)*limit,
 *       limit
 *     });
 *   }
 * }));
 */
declare const paginationHandler: <DataKey extends string = "data", CountKey extends string = "total", Item = any>(options?: PaginationOptions<DataKey, CountKey, Item>) => any;
export { paginationHandler as default, paginationHandler };