Package Exports
- ansi-escape-sequences
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ansi-escape-sequences) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
work in progress, draft documentation
A simple library containing all the known ansi escape codes and sequences.
Example
var ansi = require("ansi-escape-sequences");
Symbols
- ansi.cursorUp()
- ansi.cursorDown()
- ansi.format(str, effectArray)
- ansi.reset
- ansi.bold
- ansi.italic
- ansi.underline
- ansi.imageNegative
- ansi.fontDefault
- ansi.font2
- ansi.font3
- ansi.font4
- ansi.font5
- ansi.font6
###ansi.cursorUp()
Moves the cursor lines
(default 1) cells up. If the cursor is already at the edge of the screen, this has no effect
###ansi.cursorDown()
Moves the cursor lines
(default 1) cells down. If the cursor is already at the edge of the screen, this has no effect
###ansi.format(str, effectArray) Params
- str
string
- the string to format - effectArray
Array.<string>
- a list of sgr effects to add
Returns: string
###ansi.reset
remove all sgr effects
Type: string
###ansi.bold
Bold or increased intensity
Type: string
###ansi.italic
Type: string
###ansi.underline
Type: string
###ansi.imageNegative
Type: string
###ansi.fontDefault
Type: string
###ansi.font2
Type: string
###ansi.font3
Type: string
###ansi.font4
Type: string
###ansi.font5
Type: string
###ansi.font6
Type: string