paratext/csi
Every export of paratext/csi, with its signature and doc comment: cursorTo, cursorMove, cursorUp, cursorDown, cursorForward, cursorBackward and 25 more.
import { cursorTo, cursorMove, cursorUp, … } from 'paratext/csi';Constants
beginSynchronizedOutput
const beginSynchronizedOutput = "\u001B[?2026h";clearScreen
const clearScreen = "\u001Bc";clearTerminal
Erase the screen, the scrollback, and home the cursor. ponytail: upstream has a second form for Windows 10 before build 10586 (November 2015), whose console predates these sequences; it is not carried, so such a host gets this form. Add the branch if one is ever reported.
const clearTerminal = "\u001B[2J\u001B[3J\u001B[H";clearViewport
const clearViewport = "\u001B[2J\u001B[H";cursorBackward
const cursorBackward: (count?: number) => string;cursorDown
const cursorDown: (count?: number) => string;cursorForward
const cursorForward: (count?: number) => string;cursorGetPosition
const cursorGetPosition = "\u001B[6n";cursorHide
const cursorHide = "\u001B[?25l";cursorLeft
const cursorLeft = "\u001B[G";cursorMove
Relative move: negative x is left, negative y is up; zero emits nothing on that axis.
const cursorMove: (x: number, y?: number) => string;cursorNextLine
const cursorNextLine = "\u001B[E";cursorPrevLine
const cursorPrevLine = "\u001B[F";cursorRestorePosition
const cursorRestorePosition: string;cursorSavePosition
const cursorSavePosition: string;cursorShow
const cursorShow = "\u001B[?25h";cursorTo
cursorTo(x) moves along the line; cursorTo(x, y) to a cell. Zero-based, as upstream.
const cursorTo: (x: number, y?: number) => string;cursorUp
ansi-escapes' spelling exactly, zero included: cursorUp(0) is ESC[0A, and a terminal
reads a zero count as one, so it moves up a row. A caller that can ask for zero guards
it — @inquirer/ansi returns '' there, and caique/inquirer keeps that answer by guarding
before it calls this, rather than this changing and breaking the drop-in's byte-for-byte grade.
const cursorUp: (count?: number) => string;endSynchronizedOutput
const endSynchronizedOutput = "\u001B[?2026l";enterAlternativeScreen
const enterAlternativeScreen = "\u001B[?1049h";eraseDown
const eraseDown = "\u001B[J";eraseEndLine
const eraseEndLine = "\u001B[K";eraseLine
const eraseLine = "\u001B[2K";eraseLines
Erase count lines upward from the cursor's, then return to column one.
const eraseLines: (count: number) => string;eraseScreen
const eraseScreen = "\u001B[2J";eraseStartLine
const eraseStartLine = "\u001B[1K";eraseUp
const eraseUp = "\u001B[1J";exitAlternativeScreen
const exitAlternativeScreen = "\u001B[?1049l";scrollDown
const scrollDown = "\u001B[T";scrollUp
const scrollUp = "\u001B[S";synchronizedOutput
const synchronizedOutput: (text: string) => string;