48 lines
1.7 KiB
Handlebars
48 lines
1.7 KiB
Handlebars
|
[](https://www.npmjs.org/package/ansi-escape-sequences)
|
||
|
|
[](https://www.npmjs.org/package/ansi-escape-sequences)
|
||
|
|
[](https://travis-ci.org/75lb/ansi-escape-sequences)
|
||
|
|
[](https://david-dm.org/75lb/ansi-escape-sequences)
|
||
|
|
[](https://github.com/feross/standard)
|
||
|
|
|
||
|
|
# ansi-escape-sequences
|
||
|
|
A simple library containing all known terminal [ansi escape codes and sequences](http://en.wikipedia.org/wiki/ANSI_escape_code). Useful for adding colour to your command-line output, or building a dynamic text user interface.
|
||
|
|
|
||
|
|
## API Reference
|
||
|
|
{{#module name="ansi-escape-sequences"}}
|
||
|
|
{{>body~}}
|
||
|
|
{{>member-index~}}
|
||
|
|
{{>members~}}
|
||
|
|
{{/module}}
|
||
|
|
|
||
|
|
## Load anywhere
|
||
|
|
|
||
|
|
This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.
|
||
|
|
|
||
|
|
Node.js:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const ansi = require('ansi-escape-sequences')
|
||
|
|
```
|
||
|
|
|
||
|
|
Within Node.js with ECMAScript Module support enabled:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import ansi from 'ansi-escape-sequences'
|
||
|
|
```
|
||
|
|
|
||
|
|
Within a modern browser ECMAScript Module:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import ansi from './node_modules/ansi-escape-sequences/dist/index.mjs'
|
||
|
|
```
|
||
|
|
|
||
|
|
Old browser (adds `window.ansi`):
|
||
|
|
|
||
|
|
```html
|
||
|
|
<script nomodule src="./node_modules/ansi-escape-sequences/dist/index.js"></script>
|
||
|
|
```
|
||
|
|
|
||
|
|
* * *
|
||
|
|
|
||
|
|
© 2014-19 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
|