@inawy/stream-meter

A utility to monitor the stream progress.

Install

npm i --save @inawy/stream-meter

Usage example

1/**
2 * An example to demonistrate the strea-meter usage!
3 */
4import fs from 'fs';
5import { createGzip } from 'zlib';
6import { pipeline } from 'stream';
7import { createServer } from 'net';
8
9import { getStreamMeter } from '@inawy/stream-meter';
10
11const file = '<path/to/file>';
12
13const { watch, progress } = getStreamMeter(
14  fs.statSync(file).size, // total file size
15  true // show progress bar in terminal - default = true
16);
17
18pipeline(
19  fs.createReadStream(file),
20  createGzip(),
21  // Adding the stream-meter stream to the pipline to watch its progress
22  watch,
23  fs.createWriteStream(file + '.gz'),
24  error => {
25    if (error) console.error(error);
26  }
27);
28
29createServer(socket => {
30  // Listening to the data event from the stream-meter progress event emitter
31  progress.on('data', data => {
32    socket.write(data.toString());
33    if (data === 100) progress.removeAllListeners();
34  });
35})
36  .listen(3000)
37  .on('error', error => {});