Cursor

Wrapper around new Cursor().

Get height of TTY.

Get TTY sizes.

Get width of TTY.

By default, creates simple cursor that writes direct to stdout.

If you want to work with other streams, you can pass custom stdout and stdin streams in. It's useful when you want to chain few streams before pipe it into the cursor or want to modify what cursor pipes to stdout.

Example:

import { Cursor } from './Cursor';

// Creates simple cursor that renders direct to `process.stdout`
let cursor = new Cursor();

// Creates cursor that takes data from `stdin` and pipes to cursor.
// Afterwards to some Transform stream and `stdout`.
let cursor = new Cursor([new MyTransformStream(), process.stdout], [process.stdin]);

Set the background color. This color is used for filling the whole cell in the TTY.

Example:

import { Cursor, COLORS } from './src/Cursor';

let cursor = new Cursor();
cursor.background(COLORS.YELLOW);

Destroy the cursor.

Move the cursor down.

Erase a defined region.

Example:

import { Cursor, ERASE_REGIONS } from './src/Cursor';

let cursor = new Cursor();
cursor.erase(ERASE_REGIONS.CURRENT_LINE); // Erases current line

Fill the specified region with symbol. By default this symbol is whitespace but you can change it and fill with another symbol.

Example:

let cursor = new Cursor();

// Renders the rectangle at top of TTY
cursor.fill({x1: 0, y1: 0, x2: Cursor.getTTYWidth(), y2: 4, background: COLORS.YELLOW});

Set the foreground color. This color is used when text is rendering.

Example:

import { Cursor, COLORS } from './src/Cursor';

let cursor = new Cursor();
cursor.foreground(COLORS.BLACK);

Get the cursor position in absolute coordinates.

Example:

let cursor = new Cursor();

// Old-fashioned way
cursor.getPosition().then(position => {x: position.x, y: position.y});

// In async\await style
async function myMagicFunction() {
  let {x, y} = await cursor.getPosition();
  doSomethingWithPosition(x, y);
}

Set the cursor invisible.

Move the cursor left.

Move the cursor by the relative coordinates starting from the current position of cursor.

Removes all listeners or specified listener from the event.

If handler is not defined then removes all listeners from the specified event.

Sets a listener on cursor stream.

Resets the entire screen. It's not the same as <span><a href="class/src/Cursor.js~Cursor.html#instance-method-erase">Cursor.erase</a></span>. reset() resets the TTY settings to default.

Move the cursor right.

Set the cursor position by absolute coordinates.

Set the cursor visible.

Move the cursor up.

Write to the stream. It can be whatever info you want, but usually it's just a text that you want to print out.