Skip to content

Latest commit

 

History

History
64 lines (54 loc) · 2.74 KB

DOCUMENTATION.md

File metadata and controls

64 lines (54 loc) · 2.74 KB
Raw

Documentation

You can see below the API reference of this module.

imageToAscii(source, options, callback)

Converts the provided image in ASCII art.

Params

  • String|Buffer source: The path/url to the image or a Buffer object.
  • Object|String options: The path to the image or an object containing the following fields:

Size Options:

  • pxWidth (Number): The pixel width used for aspect ratio (default: 2).
  • size (Object): The size of the result image (ASCII art)—interpreted by compute-size:
    • height (Number|String): The height value (default: "100%").
    • width (Number|String): The width value (default: computed value to keep aspect ratio). This is optional if the height is provided.
  • size_options (Object): The options for compute-size:
    • screen_size (Object): The screen size (defaults to terminal width and height):
      • width (Number): The screen width.
      • height (Number): The screen height.
    • px_size (Object): The pixel size.
      • width (default: 1)
      • height (default: 1)
    • preserve_aspect_ratio (Boolean): If false, the aspect ratio will not be preserved (default: true).
    • fit_screen (Boolean): If false, the result size will not fit to screen (default: true).

Matrix asciifier options:

  • stringify (Boolean): If false, the pixel objects will not be stringified.
  • concat (Boolean): If false, the pixel objects will not be joined together.

Pixel asciifier options:

  • pixels (Array|String): An array or string containing the characters used for converting the pixels in strings (default: " .,:;i1tfLCG08@").
  • reverse (Boolean): If true, the pixels will be reversed creating a negative image effect (default: false).
  • colored (Boolean): If true, the output will contain ANSI styles (default: true).
  • bg (Boolean): If true, the background color will be used for coloring (default: false).
  • fg (Boolean): If true, the foreground color will be used for coloring (default: true).
  • white_bg (Boolean): Turn on the white background for transparent pixels (default: true).
  • px_background (Object): An object containing the r (red), g (green) and b (blue) values of the custom background color.

Other options:

  • image_type (String): Use this to explicitely provide the image type.
  • stringify_fn (Function): A function getting the pixels matrix and the options in the arguments. Use this option to implement your own stringifier.
  • Function callback: The callback function.