Skip to main content
Module

x/terminal_images/mod.ts>imageSettings

A Deno module and CLI tool for printing images to the console
mjrlowe/terminal_images
Go to Latest
interface imageSettings
import { type imageSettings } from "https://deno.land/x/terminal_images@3.0.0/mod.ts";

Properties

optional
path: string

The local file path or URL of the image

optional
rawFile: Uint8Array

The raw data of a PNG or JPG image

optional
rawPixels: rawPixelData

The raw data for the image: the rgb(a) array as well as the height and width

optional
characterMap: string | string[]

The character map to use when outputting the image

optional
width: number

The number of characters wide the output image is

optional
inverted: boolean

whether the character map should be inverted

optional
color: boolean

Whether the output image should be in color

optional
transparencyThreshold: number

The alpha threshold for considering a pixel transparent or opaque

optional
animationLoops: number

The number of times the image should loop if it is an animation