UNPKG

stdout-stderr/README.md

Version:

1.5 kBMarkdownView Raw

1stdout-stderr
2=============
3
4mock stdout and stderr
5
6[![Version](https://img.shields.io/npm/v/stdout-stderr.svg)](https://npmjs.org/package/stdout-stderr)
7[![CircleCI](https://circleci.com/gh/jdxcode/stdout-stderr/tree/master.svg?style=svg)](https://circleci.com/gh/jdxcode/stdout-stderr/tree/master)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/jdxcode/stdout-stderr?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/stdout-stderr/branch/master)
9[![Codecov](https://codecov.io/gh/jdxcode/stdout-stderr/branch/master/graph/badge.svg)](https://codecov.io/gh/jdxcode/stdout-stderr)
10[![Greenkeeper](https://badges.greenkeeper.io/jdxcode/stdout-stderr.svg)](https://greenkeeper.io/)
11[![Known Vulnerabilities](https://snyk.io/test/npm/stdout-stderr/badge.svg)](https://snyk.io/test/npm/stdout-stderr)
12[![Downloads/week](https://img.shields.io/npm/dw/stdout-stderr.svg)](https://npmjs.org/package/stdout-stderr)
13[![License](https://img.shields.io/npm/l/stdout-stderr.svg)](https://github.com/jdxcode/stdout-stderr/blob/master/package.json)
14
15**Usage:**
16
17```js
18const {stdout, stderr} = require('stdout-stderr')
19
20// start mocking stdout
21stdout.start()
22
23console.log('writing to stderr')
24
25// stop mocking stdout
26stdout.stop()
27
28// options
29
30// strips ansi colors by default, to disable:
31stdout.stripColor = false
32
33// also output to screen
34stdout.print = true
35```
36
37This uses the [debug](https://npm.im/debug) module so you can also see the output by setting `DEBUG=stdout|stderr|*`.

1	`stdout-stderr`
2	`=============`
3
4	`mock stdout and stderr`
5
6	`[![Version](https://img.shields.io/npm/v/stdout-stderr.svg)](https://npmjs.org/package/stdout-stderr)`
7	`[![CircleCI](https://circleci.com/gh/jdxcode/stdout-stderr/tree/master.svg?style=svg)](https://circleci.com/gh/jdxcode/stdout-stderr/tree/master)`
8	`[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/jdxcode/stdout-stderr?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/stdout-stderr/branch/master)`
9	`[![Codecov](https://codecov.io/gh/jdxcode/stdout-stderr/branch/master/graph/badge.svg)](https://codecov.io/gh/jdxcode/stdout-stderr)`
10	`[![Greenkeeper](https://badges.greenkeeper.io/jdxcode/stdout-stderr.svg)](https://greenkeeper.io/)`
11	`[![Known Vulnerabilities](https://snyk.io/test/npm/stdout-stderr/badge.svg)](https://snyk.io/test/npm/stdout-stderr)`
12	`[![Downloads/week](https://img.shields.io/npm/dw/stdout-stderr.svg)](https://npmjs.org/package/stdout-stderr)`
13	`[![License](https://img.shields.io/npm/l/stdout-stderr.svg)](https://github.com/jdxcode/stdout-stderr/blob/master/package.json)`
14
15	`Usage:`
16
17	```js
18	`const {stdout, stderr} = require('stdout-stderr')`
19
20	`// start mocking stdout`
21	`stdout.start()`
22
23	`console.log('writing to stderr')`
24
25	`// stop mocking stdout`
26	`stdout.stop()`
27
28	`// options`
29
30	`// strips ansi colors by default, to disable:`
31	`stdout.stripColor = false`
32
33	`// also output to screen`
34	`stdout.print = true`
35	```
36
37	This uses the [debug](https://npm.im/debug) module so you can also see the output by setting `DEBUG=stdout\|stderr\|*`.