@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface ImagePrinterService

    Service for rendering images in the terminal.

    Uses the Kitty or iTerm2 graphics protocol when supported, otherwise falls back to ANSI half-block character rendering. Terminal multiplexers (tmux, screen) always use the ANSI fallback as they do not pass through graphics protocol escape sequences.

    interface ImagePrinterService {
        image(
            imageBuffer: Uint8Array,
            widthPercentage?: number,
            hexFormattedBackgroundColor?: string,
        ): Promise<string>;
    }

    Implemented by

    Index
    image

    • Render an image as a string suitable for terminal output.

      Parameters

      • imageBuffer: Uint8Array

        the raw image data (e.g. PNG file contents).

      • OptionalwidthPercentage: number

        the percentage of terminal width to use for rendering. Defaults to 100.

      • OptionalhexFormattedBackgroundColor: string

        optional background color for transparent pixels. This should be a valid hex formatted string e.g. "#rrggbb". If not specified, transparent pixels show through to the terminal background.

      Returns Promise<string>

    Settings
    Member Visibility

    On This Page
    Methods