Interface: ChafaModule
January 21, 2026 ยท View on GitHub
chafa-wasm / ChafaModule
Interface: ChafaModule
An object that contains the Chafa WebAssembly module API.
Indexable
[x: string | number | symbol]: any
Properties
decodeImage()
decodeImage: (
image,callback) =>void
Decodes a PNG, JPEG or WebP image into an ImageDataLike object. If an already decoded image is specified, it will be left as is.
Parameters
image
ArrayBufferLike | ImageDataLike
callback
Returns
void
imageToAnsi()
imageToAnsi: (
image,config,callback) =>void
Converts an image into an ANSI string.
Parameters
image
ArrayBufferLike | ImageDataLike
config
callback
Callback<{ ansi: string; config: ReadonlyChafaConfig | null; }>
Returns
void
imageToCanvas()
imageToCanvas: (
image,config,callback) =>void
Converts an image into a Chafa canvas pointer.
Parameters
image
ArrayBufferLike | ImageDataLike
config
callback
Callback<{ canvas: number; config: ReadonlyChafaConfig | null; }>
Returns
void
imageToConsoleLogArgs()
imageToConsoleLogArgs: (
image,config,callback) =>void
Converts an image into an array of console.log arguments.
Parameters
image
ArrayBufferLike | ImageDataLike
config
callback
Callback<{ args: string[]; config: ReadonlyChafaConfig | null; }>
Returns
void
imageToHtml()
imageToHtml: (
image,config,callback) =>void
Converts an image into an HTML string.
Parameters
image
ArrayBufferLike | ImageDataLike
config
callback
Callback<{ config: ReadonlyChafaConfig | null; html: string; }>
Returns
void
imageToMatrix()
imageToMatrix: (
image,config,callback) =>void
Converts an image into a matrix of characters.
Parameters
image
ArrayBufferLike | ImageDataLike
config
callback
Callback<{ config: ReadonlyChafaConfig | null; matrix: number[][][]; }>
Returns
void