https://github.com/lmammino/tick-stream
A simple transform stream that can log a tick every time data is pushed through a pipe
https://github.com/lmammino/tick-stream
debug nodejs progress stream streams tick ticker utility
Last synced: 3 months ago
JSON representation
A simple transform stream that can log a tick every time data is pushed through a pipe
- Host: GitHub
- URL: https://github.com/lmammino/tick-stream
- Owner: lmammino
- License: mit
- Created: 2018-02-28T17:09:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-28T17:15:52.000Z (over 7 years ago)
- Last Synced: 2024-05-02T06:09:46.786Z (about 1 year ago)
- Topics: debug, nodejs, progress, stream, streams, tick, ticker, utility
- Language: JavaScript
- Size: 42 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tick-stream
[](http://badge.fury.io/js/tick-stream)
[](https://circleci.com/gh/lmammino/tick-stream)
[](https://codecov.io/gh/lmammino/tick-stream)
[](https://standardjs.com)
A simple transform stream that can log a tick every time data is pushed through a pipe.
## Rationale
You have a long running pipe of streams doing stuff. It's very common that, while the
pipe is being processed, you want to see some progress. How many times did you have
to implement your own stream just to console log some sort of progress?
Well, now you don't have to do that anymore and you can simply use `tick-stream` for that:
```JavaScript
const TickStream = require('tick-stream')
// initialize stream1, stream2 and stream3 somehow here
stream1
.pipe(stream2)
.pipe(stream3)
.pipe(new TickStream())
```
This code will produce an output similar to this:
```plain
tick: 0
tick: 1
tick: 2
tick: 3
```
Every line is outputted once a chunk of data has been processed by the stream.
## Install
With NPM:
```bash
npm install --save tick-stream
```
## Usage
`tick-stream` is a [`Transform` stream](https://nodejs.org/api/stream.html#stream_class_stream_transform)
that logs a message to show progress and passes the received data to the next
stream without applying any change to it.
By default the log message will count the number of chunks processed (`ticks`) using
`console.log`.
You can provide your own custom logging function with the `logFunction` option:
```javascript
const TickStream = require('tick-stream')
const tick = new TickStream({
logFunction: (chunk, encoding, tick) => {
console.log(`I am processing chunk #${tick}`, chunk)
}
})
```
In case you are working with object streams you will need to initialize your `tick-stream`
instance in `objectMode`:
```javascript
const TickStream = require('tick-stream')
const tick = new TickStream({ objectMode: true })
```
## Contributing
Everyone is very welcome to contribute to this project.
You can contribute just by submitting bugs or suggesting improvements by
[opening an issue on GitHub](https://github.com/lmammino/tick-stream/issues).
## License
Licensed under [MIT License](LICENSE). © Luciano Mammino.