Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

sisteransi

Package Overview
Dependencies
0
Maintainers
1
Versions
9
Issues
File Explorer

Advanced tools

sisteransi

ANSI escape codes for some terminal swag

    1.0.5latest

Version published
Maintainers
1
Weekly downloads
14,630,360
decreased by-9.47%

Weekly downloads

Readme

Source

sister ANSI Version Build Status Downloads

Ansi escape codes faster than you can say "Bam bam".

Installation

npm install sisteransi

Usage

const ansi = require('sisteransi'); // or const { cursor } = require('sisteransi'); const p = str => process.stdout.write(str); // move cursor to 2, 1 p(ansi.cursor.to(2, 1)); // to up, one down p(ansi.cursor.up(2)+ansi.cursor.down(1));

API

cursor

to(x, y)

Set the absolute position of the cursor. x0 y0 is the top left of the screen.

move(x, y)

Set the position of the cursor relative to its current position.

up(count = 1)

Move cursor up a specific amount of rows. Default is 1.

down(count = 1)

Move cursor down a specific amount of rows. Default is 1.

forward(count = 1)

Move cursor forward a specific amount of rows. Default is 1.

backward(count = 1)

Move cursor backward a specific amount of rows. Default is 1.

nextLine(count = 1)

Move cursor to the next line a specific amount of lines. Default is 1.

prevLine(count = 1)

Move cursor to the previous a specific amount of lines. Default is 1.

left

Move cursor to the left side.

hide

Hide cursor.

show

Show cursor.

save

Save cursor position.

restore

Restore cursor position.

scroll

up(count = 1)

Scroll display up a specific amount of lines. Default to 1.

down(count = 1)

Scroll display down a specific amount of lines. Default to 1.

erase

screen

Erase the screen and move the cursor the top left position.

up(count = 1)

Erase the screen from the current line up to the top of the screen. Default to 1.

down(count = 2)

Erase the screen from the current line down to the bottom of the screen. Default to 1.

line

Erase the entire current line.

lineEnd

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

lineStart

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

lines(count)

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

Credit

This is a fork of ansi-escapes.

License

MIT © Terkel Gjervig

Keywords

FAQs

What is sisteransi?

ANSI escape codes for some terminal swag

Is sisteransi popular?

The npm package sisteransi receives a total of 11,286,361 weekly downloads. As such, sisteransi popularity was classified as popular.

Is sisteransi well maintained?

We found that sisteransi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 18 Mar 2020

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc