tuil
ReferencePackages@mwillbanks/tuil-inkAPI

renderTerminalImage

function exported by @mwillbanks/tuil-ink.

View rawEdit

function

Public function exported by @mwillbanks/tuil-ink.

export function renderTerminalImage(
  source: TerminalImageSource,
  columns = source.width,
  color = true,
): string;

Members

This declaration has no public members.

Parameters

MemberTypeRequiredDescriptionRelated types
sourceTerminalImageSourceYesSupplies the source value as TerminalImageSource.TerminalImageSource
columnsunknownNoSupplies the columns value as unknown.
colorunknownNoSupplies the color value as unknown.

Returns

string — Returns a value that satisfies string.

Related types: —

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-ink

On this page