orbit-oss/chalk
5
4
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme.md

Browse source
This commit is contained in:
Sindre Sorhus 2018-12-28 12:24:37 +01:00 • committed by GitHub
parent 0778c57ba6
commit 99cf011a1e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

11
readme.md
View file

@ -62,7 +62,7 @@ console.log(chalk.blue('Hello world!'));
Chalk comes with an easy to use composable API where you just chain and nest the styles you want. Chalk comes with an easy to use composable API where you just chain and nest the styles you want.
For output to ***stderr*** (like `console.error` or `console.warn`) use `require('chalk/stderr')` For output to **stderr** (like `console.error`) use `require('chalk/stderr')`.
```js ```js
const chalk = require('chalk'); const chalk = require('chalk');
@ -175,16 +175,11 @@ Can be overridden by the user with the flags `--color` and `--no-color`. For sit
Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively. Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively.
### `chalk` vs `chalk/stderr`
For simplicity of use, there is `chalk/stderr` export. ## Output to `stderr`
Everything exported from `chalk` is also exported from `chalk/stderr`.
Only differense is actual value of `supportsColor` exported:
- for `chalk` import, `supportsColor` depends on `stdout` Output intended for `stderr` should use `require('chalk/stderr')` instead of `require('chalk')`. It has an identical API, but correctly detects color support for the `stderr` stream.
- for `chalk/stderr` value depends on `stderr`
This may differ if one of the standart outputs is redirected and the other is not.
## Styles ## Styles