@types/inquirer/lib/utils/paginator.d.ts

TypeScript definitions for inquirer

import ScreenManager = require("./screen-manager");

/**
 * Provides the functionality to draw paginated content using a `ScreenManager`.
 */
declare class Paginator {
    /**
     * Gets or sets the index of the currently focused line.
     */
    protected pointer: number;

    /**
     * Gets or sets the index of the last focused line.
     */
    protected lastIndex: number;

    /**
     * Gets or sets an object for drawing the paginated content.
     */
    protected screen: ScreenManager;

    /**
     * Initializes a new instance of the `Paginator` class.
     *
     * @param screenManager
     * A screen-manager for drawing the paginated content.
     */
    constructor(screenManager: ScreenManager);

    /**
     * Paginates the specified `content`.
     *
     * @param content
     * The content to paginate.
     *
     * @param selectedIndex
     * The number of the selected line.
     *
     * @returns
     * The paginated content.
     */
    paginate(content: string, selectedIndex: number): string;
}

export = Paginator;