Package Exports
- term-img2
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 (term-img2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
term-img2
Display images in your terminal
Even animated gifs!
Currently only supported on iTerm >=2.9.
Install
$ npm install --save term-img2Usage
const termImg = require('term-img2');
termImg('unicorn.jpg', {log: true});API
termImg(input, [options])
input
Type: string buffer
Filepath to an image or an image as a buffer.
options
width
height
Type: string number
The width and height are given as a number followed by a unit, or the word "auto".
N: N character cells.Npx: N pixels.N%: N percent of the session's width or height.auto: The image's inherent size will be used to determine an appropriate dimension.
preserveAspectRatio
Type: boolean
Default: true
log
Type: boolean
Log image in terminal, false by default.
fallback
Type: function
Default: () => throw new UnsupportedTerminal()
Enables you to do something else when the terminal doesn't support images.
return
Type: string
The image string that can be displayed in terminal.
Related
- imgcat - CLI for this module
License
MIT © EGOIST