Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ascii-art-image

Package Overview
Dependencies
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ascii-art-image

``` _ _ _ (_)(_) | | __ _ ___ ___ _ _ ______ __ _ _ __ | |_ / _` |/ __| / __|| || ||______| / _` || '__|| __| | (_| |\__ \| (__ | || | | (_| || | | |_ \_

  • 1.4.0
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
1.1K
increased by55.1%
Maintainers
1
Weekly downloads
 
Created
Source
                   _  _                       _
                  (_)(_)                     | |
  __ _  ___   ___  _  _  ______   __ _  _ __ | |_
 / _` |/ __| / __|| || ||______| / _` || '__|| __|
| (_| |\__ \| (__ | || |        | (_| || |   | |_
 \__,_||___/ \___||_||_|         \__,_||_|    \__|

ascii-art-image.js

NPM version npm Travis

Installation

npm install ascii-art-image

Usage

require('ascii-art-image')

To do anything with it, you'll need to include the library:

const Image = require('ascii-art-image');

new Image(options)

the constructor takes an options argument

Kind: static property of ascii-art-image

ParamTypeDescription
optionsObjectthe set of options being passed
options.alphabetstringcharacters used to draw the image. One of: variant1, variant2, variant3, variant4, ultra-wide, wide, hatching, bits, binary, greyscale, blocks
options.filepathstringThe path of the image
options.widthIntThe width to render the image
options.heightIntThe height to render the image
options.distancefunctiona function which takes in 6 args (2x rgb) and returns a measure of distance between these two colors

Examples

Image.create(options, callback)

Map through an ansi string one character at a time, without any of those characters being styles.

Kind: static property of ascii-art-image

ParamTypeDescription
optionsObjectthe set of options being passed
options.alphabetstringcharacters used to draw the image. One of: variant1, variant2, variant3, variant4, ultra-wide, wide, hatching, bits, binary, greyscale, blocks
options.filepathstringThe path of the image
options.widthIntThe width to render the image
options.heightIntThe height to render the image
options.distancefunctiona function which takes in 6 args (2x rgb) and returns a measure of distance between these two colors

Examples

for example, say we want to generate a copy of a metropolis poster:

Image Output

You just need to do something like this:

var Image = require('ascii-art-image');

var image = new Image({
    filepath: '~/Images/metropolis.jpg',
    alphabet:'variant4'
});

image.write(function(err, rendered){
    console.log(rendered);
})

Image Output

FAQs

Package last updated on 17 May 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc