StringFormat | @thi.ng/text-canvas

Hierarchy

StringFormat

Index

Properties

end
prefix
start
suffix
zero

Properties

end

end: string

Format end string (e.g. to ANSI reset or </span>).

prefix

prefix: string

Prefix for each canvas row / line result string

start

start: Fn<number, string>

Function translating canvas character format codes to the actual output format. This function will only be called when needed, i.e. when a character's format is different than that of the previous.

suffix

suffix: string

Suffix for each canvas row / line result string (e.g. linebreak)

Optional zero

zero: boolean

If true, DON'T skip 0-valued format IDs during formatting.

remarks: This is needed for various custom color-only formats, e.g. in order to reproduce black in FMT_ANSI565. In the default format, a zero refers to the default format of the target.
defaultvalue: false