less-pager-mini/dist/index.d.ts

A scrollable terminal pager for Node.js CLI apps (terminal only)

/**
 * Less-pager-mini
 *
 * - If `examineFile` is true, treats input as file path(s) and loads file
 *   content.
 * - Otherwise, converts arbitrary input into displayable string content.
 *
 * @param input - The input to render, which can be a string, object, or array.
 * @param preserveFormat - Whether to preserve original formatting
 *                         (no indentation).
 * @param examineFile - If true, treats input as file path(s) and reads from
 *                      disk.
 */
export default function pager(input: unknown, preserveFormat?: boolean, examineFile?: boolean): Promise<void>;