nodejs-ansibuffer

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #linux #docker #nodejs #macos #cli #awesome-list #security #ios #openai #open-source

nodejs-ansibuffer

(★ 10)

Escape code aware (ANSI) chunked input/output buffer (BBS like - for telnet)

nodejs-ansibuffer Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

ANSIBuffer
==========

Purpose
-------
nodejs-ANSIBuffer is a chunked, escape code aware input/output buffer for use in
BBS-like telnet programs.  It's *primary* use it to provide a factory to mimic the
delay that we were all used to in the old BBS days.

TOC
---
* [Usage](#usage)
* [ANSIBuffer API](#api)
* [ANSIChars](#chars)
* [ANSICenter](#center)
* [ANSIRightAlign](#right)
* [Backtick Color](#backtick)
* [Status](#status)
* [Contributors](#contrib)
* [Compatibility](#compat)
* [Licence](#lic)

<a name="usage"></a>Usage
-----
	var net = require('net');
	var ansi = require('nodejs-ansibuffer');

<a name="api"></a>ANSIBuffer() API
----------------

To create a new buffer, import the module, and create a new ANSIBuffer() object.

var ansi = require('nodejs-ansibuffer');
	var buffer = new ansi.ANSIBuffer();

#### ANSIBuffer.dump()
Returns the full contents of the buffer, while emptying it.

#### ANSIBuffer.bite()
Returns an inteligent "chunk" of the buffer, of variable length.  Great pains are
taken to never "break" an ANSI control sequence - odd things happen when there is
a manufactured delay in these - well, sometimes anyway.

#### ANSIBuffer.clear()
Empty the buffer, drop all the contents.

#### ANSIBuffer.queue( text )
Queue text for display.  This can be plain text, a string containing full escape
codes, or a string containing "Legend of the Red Dragon" [backtick](#backtick) codes.

#### ANSIBuffer.center( text, [width] )
Queue text for display (same as above) - But center it *on an 80 column screen*.
If not specified, defaults to a TERM width of 80.

## <a name="chars"></a>ANSIChars
This is an object that contains some well-used high-ASCII characters, reimagined
in unicode.

* A176 - &#x2591; - Light Shade
 * A177 - &#x2592; - Medium Shade
 * A178 - &#x2593; - Dark Shade
 * A219 - &#x2588; - Full Fill
 * A220 - &#x2584; - Bottom Half Box
 * A221 - &#x258c; - Left Half Box
 * A222 - &#x2590; - Right Half Box
 * A223 - &#x2580; - Top Half Box
 * A254 - &#x25aa; - Center Square
 * ESC - Escape Sequence Start "{ESC}["
 
## <a name="center"></a>ANSICenter(text, [width]);
This is a function that allows you to center an ANSI string prior to queueing it.

## <a name="right"></a>ANSIRightAlign(text, column, [absolute]);
This is a function that allows you to right-align an ANSI string prior to 
queueing it. Column can be either "absolute" (default), or based on the rest of
the line.

a/n: Absolute method moves to the named column, then backs up the length of the
string.  Relative method "spaces" over that many columns, then backs up the
length of the string.

<a name="backtick"></a>Backtick Color
-----------------
These are the backtick color codes based on how the [Legend of the Red Dragon](http://en.wikipedia.org/wiki/Legend_of_the_Red_Dragon) did things.

* `1 : Dark Red
 * `2 : Dark Green
 * `3 : Dark Yellow or Brown (depends on terminal)
 * `4 : Dark Blue
 * `5 : Dark Magenta or Purple (depends on terminal)
 * `6 : Dark Cyan
 * `7 : Light Grey (a.k.a. Dark White) (a.k.a. Normal)
 * `8 : Dark Grey (a.k.a. Light Black)
 * `9 : Bright Red
 * `0 : Bright Green
 * `! : Bright Yellow
 * `@ : Bright Blue
 * `# : Bright Magenta
 * `$ : Bright Cyan
 * `% : Bright White
 * `. : Reset to TERM Default

### Mac Defaults:
Note the lack of dark grey.  This is an issue with the default colors on the mac
terminal. (taken from iTerm - terminal.app is even worse)

![Mac Color Options](https://raw.github.com/jtsage/nodejs-ansibuffer/master/screens/color-test-mac.png)

### Linux Defaults:
Taken in terminator.  gnome-terminal is comparable

![Linux Color Options](https://raw.github.com/jtsage/nodejs-ansibuffer/master/screens/color-test-linux.png)

## <a name="status"></a>Current status
This module is in a development stage. It's probably broken horribly in places - not sure.

## <a name="contrib"></a>Contributors
* [J.T. Sage](https://github.com/jtsgae/)

## <a name="compat"></a>Compatibility
This module was only tested using node >= 0.8.8. There is no reason it shouldn't
run under earlier versions though.

## <a name="lic"></a>Licence
node-ansibuffer is licensed under the MIT license. Or the BSD license. Or no license if 
that's more convient for you.

nodejs-ansibuffer

nodejs-ansibuffer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

nodejs-ansibuffer

nodejs-ansibuffer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README