terminal-image-resizeable

    0.1.3 • Public • Published

    terminal-image Build Status

    Display images in the terminal

    Works in any terminal that supports colors.

    In iTerm, the image will be displayed in full resolution, since iTerm has special image support.

    Install

    $ npm install terminal-image
    

    Usage

    const terminalImage = require('terminal-image');
     
    (async () => {
        console.log(await terminalImage.file('unicorn.jpg'));
    })();

    API

    Supports PNG and JPEG images.

    terminalImage.buffer(imageBuffer)

    Returns a Promise<string> with the ansi escape codes to display the image.

    imageBuffer

    Type: Buffer

    Buffer with the image.

    terminalImage.file(filePath)

    Returns a Promise<string> with the ansi escape codes to display the image.

    filePath

    Type: string

    File path to the image.

    Tip

    Display a remote image

    const terminalImage = require('terminal-image');
    const got = require('got');
     
    (async () => {
        const {body} = await got('sindresorhus.com/unicorn', {encoding: null});
        console.log(await terminalImage.buffer(body));
    })();

    Related

    License

    MIT © Sindre Sorhus

    Install

    npm i terminal-image-resizeable

    DownloadsWeekly Downloads

    0

    Version

    0.1.3

    License

    MIT

    Unpacked Size

    4.21 kB

    Total Files

    4

    Last publish

    Collaborators

    • nao20010128nao