Package Exports

img-term-string

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (img-term-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

img-term-string

From image url or file to a string that can be used to render the image in the terminal.

Currently supported on iTerm2 >= 3.

Install

$ npm install --save img-term-string

Usage

const imgTermString = require('img-term-string');

imgTermString({ src: "https://someimage.png or path/to/local/image" })
    .then(imgString => { console.log(imgString) });
// returns the image string and logs it to the terminal

API

imgTermString(options)

Returns a the formatted image string via promise or callback.

src

Type: string

The url or file path of the image.

width

height

Type: string number
Default: auto
Options: Npx N% N auto

Optional arguments. Set the width and height of the image.

in pixels(Npx)
as a % of the terminal view(N%)
number of char cells(N)
autoscale based on the image dimensions(auto)

License

MIT