AnsiToken

AnsiToken = { kind: "text"; text: string; } | { final: string; intermediates: string; kind: "csi"; parameters: string; } | { body: string; kind: "osc"; terminator: "bel" | "st"; }

Defined in: packages/format-ansi/src/ansi-token.ts:10

One unit of an ANSI byte stream.

text carries everything that is not an escape sequence; the sequence kinds keep their parameter and intermediate bytes verbatim, so an encoder can reproduce the original stream exactly.

Union Members

Type Literal

{ kind: "text"; text: string; }

---

Type Literal

{ final: string; intermediates: string; kind: "csi"; parameters: string; }

final

readonly final: string

intermediates

readonly intermediates: string

kind

readonly kind: "csi"

ESC [ … final byte: cursor motion, erase, SGR.

parameters

readonly parameters: string

---

Type Literal

{ body: string; kind: "osc"; terminator: "bel" | "st"; }

body

readonly body: string

kind

readonly kind: "osc"

ESC ] … BEL or ST: window title, OSC 8 hyperlink.

terminator

readonly terminator: "bel" | "st"

Which terminator closed it, since both are legal and round-trip.