@thi.ng/transducers/page.d.ts

Collection of ~170 lightweight, composable transducers, reducers, generators, iterators for functional data transformations

import type { Transducer } from "./api.js";
/**
 * Pagination helper. Returns transducer which extracts only items for given
 * page number (and page length, default 10).
 *
 * @remarks
 * When {@link comp}osing with other transducers, it's most efficient if `page`
 * is used as early as possible / prior to any heavy processing steps.
 *
 * @example
 * ```ts tangle:../export/page.ts
 * import { page, range } from "@thi.ng/transducers";
 *
 * console.log(
 *   [...page(0, 5, range(12))]
 * );
 * // [ 0, 1, 2, 3, 4 ]
 *
 * console.log(
 *   [...page(1, 5, range(12))]
 * );
 * // [ 5, 6, 7, 8, 9 ]
 *
 * console.log(
 *   [...page(2, 5, range(12))]
 * );
 * // [ 10, 11 ]
 *
 * console.log(
 *   [...page(3, 5, range(12))]
 * );
 * // []
 * ```
 *
 * @param page -
 * @param pageLen -
 */
export declare function page<T>(page: number, pageLen?: number): Transducer<T, T>;
export declare function page<T>(page: number, src: Iterable<T>): IterableIterator<T>;
export declare function page<T>(page: number, pageLen: number, src: Iterable<T>): IterableIterator<T>;
//# sourceMappingURL=page.d.ts.map