Chain | /ansi/chain.ts | cliffy@v0.19.0

interface Chain

import { type Chain } from "https://dotland.deno.dev/x/cliffy@v0.19.0/ansi/chain.ts";

Chainable ansi escape method declarations.

Type Parameters

T extends Chain<T>

Properties

text: (text: string) => T

Add text.

bel: T

Ring audio bell: \u0007

cursorPosition: T

Get cursor position.

cursorTo: (x: number, y?: number) => T

Move cursor to x, y, counting from the top left corner.

cursorMove: (x: number, y: number) => T

Move cursor by offset.

cursorUp: T & ((count: number) => T)

Move cursor up by n lines.

cursorDown: T & ((count: number) => T)

Move cursor down by n lines.

cursorForward: T & ((count: number) => T)

Move cursor forward by n lines.

cursorBackward: T & ((count: number) => T)

Move cursor backward by n lines.

cursorNextLine: T & ((count: number) => T)

Move cursor to the beginning of the line n lines down.

cursorPrevLine: T & ((count: number) => T)

Move cursor to the beginning of the line n lines up.

cursorLeft: T

Move cursor to first column of current row.

cursorHide: T

Hide cursor.

cursorShow: T

Show cursor.

cursorSave: T

Save cursor.

cursorRestore: T

Restore cursor.

scrollUp: T & ((count: number) => T)

Scroll window up by n lines.

scrollDown: T & ((count: number) => T)

Scroll window down by n lines.

eraseScreen: T

Clear screen.

eraseUp: T & ((count: number) => T)

Clear screen up by n lines.

eraseDown: T & ((count: number) => T)

Clear screen down by n lines.

eraseLine: T

Clear current line.

eraseLineEnd: T

Clear to line end.

eraseLineStart: T

Clear to line start.

eraseLines: (count: number) => T

Clear screen and move cursor by n lines up and move cursor to first column.

clearScreen: T

Clear the terminal screen. (Viewport)

clearTerminal: T

Clear the whole terminal, including scrollback buffer. (Not just the visible part of it).

link: (text: string, url: string) => T

Create link.

image: (buffer: string | ArrayBuffer, options?: ImageOptions) => T

Create image.