Ansi

67 exports Since v1.0.0 Source

Colors

bgBlack

Since v1.0.0

Signature

declare const bgBlack: Ansi

bgBlackBright

Since v1.0.0

Signature

declare const bgBlackBright: Ansi

bgBlue

Since v1.0.0

Signature

declare const bgBlue: Ansi

bgBlueBright

Since v1.0.0

Signature

declare const bgBlueBright: Ansi

bgCyan

Since v1.0.0

Signature

declare const bgCyan: Ansi

bgCyanBright

Since v1.0.0

Signature

declare const bgCyanBright: Ansi

bgGreen

Since v1.0.0

Signature

declare const bgGreen: Ansi

bgGreenBright

Since v1.0.0

Signature

declare const bgGreenBright: Ansi

bgMagenta

Since v1.0.0

Signature

declare const bgMagenta: Ansi

bgMagentaBright

Since v1.0.0

Signature

declare const bgMagentaBright: Ansi

bgRed

Since v1.0.0

Signature

declare const bgRed: Ansi

bgRedBright

Since v1.0.0

Signature

declare const bgRedBright: Ansi

bgWhite

Since v1.0.0

Signature

declare const bgWhite: Ansi

bgWhiteBright

Since v1.0.0

Signature

declare const bgWhiteBright: Ansi

bgYellow

Since v1.0.0

Signature

declare const bgYellow: Ansi

bgYellowBright

Since v1.0.0

Signature

declare const bgYellowBright: Ansi

black

Since v1.0.0

Signature

declare const black: Ansi

blackBright

Since v1.0.0

Signature

declare const blackBright: Ansi

blue

Since v1.0.0

Signature

declare const blue: Ansi

blueBright

Since v1.0.0

Signature

declare const blueBright: Ansi

cyan

Since v1.0.0

Signature

declare const cyan: Ansi

cyanBright

Since v1.0.0

Signature

declare const cyanBright: Ansi

green

Since v1.0.0

Signature

declare const green: Ansi

greenBright

Since v1.0.0

Signature

declare const greenBright: Ansi

magenta

Since v1.0.0

Signature

declare const magenta: Ansi

magentaBright

Since v1.0.0

Signature

declare const magentaBright: Ansi

red

Since v1.0.0

Signature

declare const red: Ansi

redBright

Since v1.0.0

Signature

declare const redBright: Ansi

white

Since v1.0.0

Signature

declare const white: Ansi

whiteBright

Since v1.0.0

Signature

declare const whiteBright: Ansi

yellow

Since v1.0.0

Signature

declare const yellow: Ansi

yellowBright

Since v1.0.0

Signature

declare const yellowBright: Ansi

Commands

beep

Since v1.0.0

Play a beeping sound.

Signature

declare const beep: Ansi

cursorBackward

Since v1.0.0

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) => Ansi

cursorDown

Since v1.0.0

Moves 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) => Ansi

cursorForward

Since v1.0.0

Moves 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) => Ansi

cursorHide

Since v1.0.0

Hides the cursor.

Signature

declare const cursorHide: Ansi

cursorLeft

Since v1.0.0

Moves the cursor to the first column of the current row.

Signature

declare const cursorLeft: Ansi

cursorMove

Since v1.0.0

Move 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) => Ansi

cursorNextLine

Since v1.0.0

Moves cursor to beginning of the line the specified number of rows down (default 1).

Signature

declare const cursorNextLine: (rows?: number) => Ansi

cursorPrevLine

Since v1.0.0

Moves cursor to beginning of the line the specified number of rows up (default 1).

Signature

declare const cursorPrevLine: (rows?: number) => Ansi

cursorRestorePosition

Since v1.0.0

Restores 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: Ansi

cursorSavePosition

Since v1.0.0

Saves the cursor position, encoding shift state and formatting attributes.

Signature

declare const cursorSavePosition: Ansi

cursorShow

Since v1.0.0

Shows the cursor.

Signature

declare const cursorShow: Ansi

cursorTo

Since v1.0.0

Moves 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) => Ansi

cursorUp

Since v1.0.0

Moves 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) => Ansi

eraseDown

Since v1.0.0

Clears from the current cursor position to the end of the screen.

The current cursor position does not change.

Signature

declare const eraseDown: Ansi

eraseEndLine

Since v1.0.0

Clears from the current cursor position to the end of the current line.

The current cursor position does not change.

Signature

declare const eraseEndLine: Ansi

eraseLine

Since v1.0.0

Clears the current line.

The current cursor position does not change.

Signature

declare const eraseLine: Ansi

eraseLines

Since v1.0.0

Erase from the current cursor position up the specified amount of rows.

Signature

declare const eraseLines: (rows: number) => Ansi

eraseScreen

Since v1.0.0

Clears the entire screen and move the cursor to the upper left.

Signature

declare const eraseScreen: Ansi

eraseStartLine

Since v1.0.0

Clears from the current cursor position to the start of the current line.

The current cursor position does not change.

Signature

declare const eraseStartLine: Ansi

eraseUp

Since v1.0.0

Clears from the current cursor position to the beginning of the screen.

The current cursor position does not change.

Signature

declare const eraseUp: Ansi

Constructors

bgColor

Since v1.0.0

Signature

declare const bgColor: (color: Color) => Ansi

bgColorBright

Since v1.0.0

Signature

declare const bgColorBright: (color: Color) => Ansi

bold

Since v1.0.0

Signature

declare const bold: Ansi

brightColor

Since v1.0.0

Signature

declare const brightColor: (color: Color) => Ansi

color

Since v1.0.0

Signature

declare const color: (color: Color) => Ansi

italicized

Since v1.0.0

Signature

declare const italicized: Ansi

strikethrough

Since v1.0.0

Signature

declare const strikethrough: Ansi

underlined

Since v1.0.0

Signature

declare const underlined: Ansi

Destructors

stringify

Since v1.0.0

Signature

declare const stringify: (self: Ansi) => string

Model

Ansi

interface

Since v1.0.0

Signature

interface Ansi extends Proto {}

Signature

declare const combine: {
  (that: Ansi): (self: Ansi) => Ansi;
  (self: Ansi, that: Ansi): Ansi;
}

Symbol

AnsiTypeId

Since v1.0.0

Signature

declare const AnsiTypeId: unique symbol

AnsiTypeId

type

Since v1.0.0

Signature

type AnsiTypeId = typeof AnsiTypeId