flagstaff/log-update

import logUpdate from 'flagstaff/log-update';
import { createLogUpdate, logUpdateStderr } from 'flagstaff/log-update';

function createLogUpdate(stream: LogUpdateStream, { showCursor: keepCursor, defaultWidth, defaultHeight }?: LogUpdateOptions): LogUpdate;

const logUpdate: LogUpdate;

const logUpdateStderr: LogUpdate;

interface LogUpdate {
    (...text: unknown[]): void;
    /** Erase the current frame, leaving nothing behind. */
    clear(): void;
    /** Give up the rows: the frame stays on screen and the next render starts fresh. */
    done(): void;
    /** Replace the frame with text that stays, unclipped, and start fresh after it. */
    persist(...text: unknown[]): void;
}

interface LogUpdateOptions {
    /** Leave the cursor visible while a frame is up. Default false. */
    showCursor?: boolean;
    /** Columns to assume when the stream reports none. Default 80. */
    defaultWidth?: number;
    /** Rows to assume when the stream reports none. Default 24. */
    defaultHeight?: number;
}

interface LogUpdateStream {
    write(chunk: string): unknown;
    columns?: number;
    rows?: number;
    isTTY?: boolean;
}

type Options = LogUpdateOptions;