@wwa/single-line-log/README.md

Keep writing to the same line in the terminal. Very useful when you write progress bars, or a status message during longer operations

# single-line-log

Node.js module that keeps writing to the same line in the console (or a stream). Very useful when you write progress bars, or a status message during longer operations. Supports multilines.

## Installation

```sh
npm install @wwa/single-line-log
```

## Usage

``` js
const log = require('@wwa/single-line-log').stdout;
// or pass any stream:
// const log = require('single-line-log')(process.stdout);

let read = 0;
const size = fs.statSync('super-large-file').size;

const rs = fs.createReadStream('super-large-file');
rs.on('data', function(data) {
	read += data.length;
	var percentage = Math.floor(100*read/size);

	// Keep writing to the same two lines in the console
	log('Writing to super large file\n[' + percentage + '%]', read, 'bytes read');
});
```

## .clear()

Clears the log (i.e., writes a newline).

``` js
var log = require('single-line-log').stdout;

log('Line 1');
log.clear();
log('Line 2');
```

## .stdout

Outputs to `process.stdout`.

## .stderr

Outputs to `process.stderr`.

## License

MIT