| Server IP : 127.0.0.2 / Your IP : 3.137.161.250 Web Server : Apache/2.4.18 (Ubuntu) System : User : www-data ( ) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : disk_free_space,disk_total_space,diskfreespace,dl,exec,fpaththru,getmyuid,getmypid,highlight_file,ignore_user_abord,leak,listen,link,opcache_get_configuration,opcache_get_status,passthru,pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,php_uname,phpinfo,posix_ctermid,posix_getcwd,posix_getegid,posix_geteuid,posix_getgid,posix_getgrgid,posix_getgrnam,posix_getgroups,posix_getlogin,posix_getpgid,posix_getpgrp,posix_getpid,posix,_getppid,posix_getpwnam,posix_getpwuid,posix_getrlimit,posix_getsid,posix_getuid,posix_isatty,posix_kill,posix_mkfifo,posix_setegid,posix_seteuid,posix_setgid,posix_setpgid,posix_setsid,posix_setuid,posix_times,posix_ttyname,posix_uname,pclose,popen,proc_open,proc_close,proc_get_status,proc_nice,proc_terminate,shell_exec,source,show_source,system,virtual MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/npm/node_modules/ansistyles/ |
Upload File : |
# ansistyles [](http://next.travis-ci.org/thlorenz/ansistyles)
Functions that surround a string with ansistyle codes so it prints in style.
In case you need colors, like `red`, have a look at [ansicolors](https://github.com/thlorenz/ansicolors).
## Installation
npm install ansistyles
## Usage
```js
var styles = require('ansistyles');
console.log(styles.bright('hello world')); // prints hello world in 'bright' white
console.log(styles.underline('hello world')); // prints hello world underlined
console.log(styles.inverse('hello world')); // prints hello world black on white
```
## Combining with ansicolors
Get the ansicolors module:
npm install ansicolors
```js
var styles = require('ansistyles')
, colors = require('ansicolors');
console.log(
// prints hello world underlined in blue on a green background
colors.bgGreen(colors.blue(styles.underline('hello world')))
);
```
## Tests
Look at the [tests](https://github.com/thlorenz/ansistyles/blob/master/test/ansistyles.js) to see more examples and/or run them via:
npm explore ansistyles && npm test
## More Styles
As you can see from [here](https://github.com/thlorenz/ansistyles/blob/master/ansistyles.js#L4-L15), more styles are available,
but didn't have any effect on the terminals that I tested on Mac Lion and Ubuntu Linux.
I included them for completeness, but didn't show them in the examples because they seem to have no effect.
### reset
A style reset function is also included, please note however that this is not nestable.
Therefore the below only underlines `hell` only, but not `world`.
```js
console.log(styles.underline('hell' + styles.reset('o') + ' world'));
```
It is essentially the same as:
```js
console.log(styles.underline('hell') + styles.reset('') + 'o world');
```
## Alternatives
**ansistyles** tries to meet simple use cases with a very simple API. However, if you need a more powerful ansi formatting tool,
I'd suggest to look at the [features](https://github.com/TooTallNate/ansi.js#features) of the [ansi module](https://github.com/TooTallNate/ansi.js).