From 4081c2036a5af21519095da1b8b99c507b0fba93 Mon Sep 17 00:00:00 2001 From: Minteck Date: Sun, 17 Apr 2022 17:37:10 +0200 Subject: Deprecation --- node_modules/sisteransi/readme.md | 113 -------------------------------------- 1 file changed, 113 deletions(-) delete mode 100644 node_modules/sisteransi/readme.md (limited to 'node_modules/sisteransi/readme.md') diff --git a/node_modules/sisteransi/readme.md b/node_modules/sisteransi/readme.md deleted file mode 100644 index 632f0d7..0000000 --- a/node_modules/sisteransi/readme.md +++ /dev/null @@ -1,113 +0,0 @@ -# sister ANSI [![Version](https://img.shields.io/npm/v/sisteransi.svg)](https://www.npmjs.com/package/sisteransi) [![Build Status](https://travis-ci.org/terkelg/sisteransi.svg?branch=master)](https://travis-ci.org/terkelg/sisteransi) [![Downloads](https://img.shields.io/npm/dm/sisteransi.svg)](https://www.npmjs.com/package/sisteransi) - -> Ansi escape codes faster than you can say "[Bam bam](https://www.youtube.com/watch?v=OcaPu9JPenU)". - -## Installation - -``` -npm install sisteransi -``` - - -## Usage - -```js -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](https://github.com/sindresorhus/ansi-escapes). - - -## License - -MIT © [Terkel Gjervig](https://terkel.com) -- cgit