AnsiDoc
Commands
Moves the cursor backward by the specified number of columns (default 1)
relative to the current cursor position.
If the cursor is already at the edge of the screen, this has no effect.
Signature
declare const cursorBackward: (columns?: number) => AnsiDocMoves the cursor down by the specified number of lines (default 1)
relative to the current cursor position.
If the cursor is already at the edge of the screen, this has no effect.
Signature
declare const cursorDown: (lines?: number) => AnsiDocMoves the cursor forward by the specified number of columns (default 1)
relative to the current cursor position.
If the cursor is already at the edge of the screen, this has no effect.
Signature
declare const cursorForward: (columns?: number) => AnsiDocHides the cursor.
Signature
declare const cursorHide: AnsiDocMoves the cursor to the first column of the current row.
Signature
declare const cursorLeft: AnsiDocMoves cursor to beginning of the line the specified number of rows down
(default 1).
Signature
declare const cursorNextLine: (rows?: number) => AnsiDocMoves cursor to beginning of the line the specified number of rows up
(default 1).
Signature
declare const cursorPrevLine: (rows?: number) => AnsiDocRestores the cursor position, encoding shift state and formatting attributes from the previous save, if any, otherwise resets these all to their defaults.
Signature
declare const cursorRestorePosition: AnsiDocSaves the cursor position, encoding shift state and formatting attributes.
Signature
declare const cursorSavePosition: AnsiDocShows the cursor.
Signature
declare const cursorShow: AnsiDocMoves the cursor up by the specified number of lines (default 1) relative
to the current cursor position.
If the cursor is already at the edge of the screen, this has no effect.
Signature
declare const cursorUp: (lines?: number) => AnsiDocClears from the current cursor position to the end of the screen.
The current cursor position does not change.
Signature
declare const eraseDown: AnsiDocClears from the current cursor position to the end of the current line.
The current cursor position does not change.
Signature
declare const eraseEndLine: AnsiDocClears the current line.
The current cursor position does not change.
Signature
declare const eraseLine: AnsiDocErase from the current cursor position up the specified amount of rows.
Signature
declare const eraseLines: (rows: number) => AnsiDocClears the entire screen and move the cursor to the upper left.
Signature
declare const eraseScreen: AnsiDocClears from the current cursor position to the start of the current line.
The current cursor position does not change.
Signature
declare const eraseStartLine: AnsiDocClears from the current cursor position to the beginning of the screen.
The current cursor position does not change.
Signature
declare const eraseUp: AnsiDocConstructors
Play a beeping sound.
Signature
declare const beep: AnsiDocMove the cursor position the specified number of rows and columns
relative to the current cursor position.
If the cursor is already at the edge of the screen in either direction, then additional movement will have no effect.
Signature
declare const cursorMove: (column: number, row?: number) => AnsiDocMoves the cursor to the specified row and column.
Though the ANSI Control Sequence for Cursor Position is 1-based, this
method takes row and column values starting from 0 and adjusts them to 1-
based values.
Signature
declare const cursorTo: (column: number, row?: number) => AnsiDocDestructors
Text leaves are rendered verbatim, including control characters. Apply
sanitize to untrusted subtrees before writing the result to a terminal.
Use the raw document when embedded terminal sequences are trusted and
intentional.
Signature
declare const render: { (config: RenderConfig): (self: Doc) => string; (self: Doc, config: RenderConfig): string;}