streamspeed 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,7 +2,8 @@
2
2
 
3
3
  A simple way to keep track of the speed of your readable streams.
4
4
 
5
- ![Depfu](https://img.shields.io/depfu/fent/node-streamspeed)
5
+ [![npm](https://img.shields.io/npm/v/streamspeed)](https://www.npmjs.com/package/streamspeed)
6
+ [![Node.js CI](https://github.com/fent/node-streamspeed/actions/workflows/nodejs.yml/badge.svg)](https://github.com/fent/node-streamspeed/actions/workflows/nodejs.yml)
6
7
  [![codecov](https://codecov.io/gh/fent/node-streamspeed/branch/master/graph/badge.svg)](https://codecov.io/gh/fent/node-streamspeed)
7
8
 
8
9
  # Usage
package/dist/index.d.ts CHANGED
@@ -1,7 +1,6 @@
1
- /// <reference types="node" />
2
- import { EventEmitter } from 'events';
3
- import { Readable } from 'stream';
4
- import { Options } from './speedometer';
1
+ import { EventEmitter } from 'node:events';
2
+ import { type Readable } from 'node:stream';
3
+ import { type Options } from './speedometer';
5
4
  declare namespace StreamSpeed {
6
5
  interface Options {
7
6
  timeUnit?: number;
@@ -13,41 +12,28 @@ declare namespace StreamSpeed {
13
12
  }
14
13
  }
15
14
  declare class StreamSpeed extends EventEmitter {
15
+ static StreamSpeed: typeof StreamSpeed;
16
+ static default: typeof StreamSpeed;
16
17
  options: Options;
17
18
  private _streams;
18
19
  /**
19
20
  * Emits speed for a group of streams.
20
- *
21
- * @constructor
22
- * @extends {EventEmitter}
23
- * @param {Object?} options
24
- * @param {number?} options.timeUnit The time unit speed will be measured in.
25
- * @param {number?} options.range Time in ms to calculate speed over.
26
21
  */
27
22
  constructor(options?: {});
28
23
  /**
29
24
  * Updates the group with the latest change in speed.
30
- *
31
- * @param {Readable} origstream
32
- * @param {number} speed
33
25
  */
34
26
  _update(origstream: Readable, speed: number): void;
35
27
  /**
36
28
  * Convenient method that returns list of streams in this group.
37
- *
38
- * @return {Array.<Readable>}
39
29
  */
40
30
  getStreams(): Readable[];
41
31
  /**
42
32
  * Add stream to group.
43
- *
44
- * @param {Readable} stream
45
33
  */
46
34
  add(origstream: Readable): void;
47
35
  /**
48
36
  * Remove stream from group.
49
- *
50
- * @param {Readable} stream
51
37
  */
52
38
  remove(stream: Readable): void;
53
39
  /**
@@ -56,19 +42,11 @@ declare class StreamSpeed extends EventEmitter {
56
42
  getSpeed(): number;
57
43
  /**
58
44
  * Get an individual stream's speed.
59
- *
60
- * @param {Readable} stream
61
45
  */
62
46
  getStreamSpeed(stream: Readable): number;
63
47
  /**
64
48
  * Converts bytes to human readable unit.
65
49
  * Thank you Amir from StackOverflow.
66
- *
67
- * @param {number} bytes
68
- * @param {Object} options
69
- * @param {string} options.timeUnit
70
- * @param {number?} options.precision
71
- * @return {string}
72
50
  */
73
51
  static toHuman(bytes: number, options?: StreamSpeed.ToHumanOptions): string;
74
52
  }
package/dist/index.js CHANGED
@@ -1,16 +1,10 @@
1
1
  "use strict";
2
- const events_1 = require("events");
3
- const stream_1 = require("stream");
2
+ const node_events_1 = require("node:events");
3
+ const node_stream_1 = require("node:stream");
4
4
  const speedometer_1 = require("./speedometer");
5
- class StreamSpeed extends events_1.EventEmitter {
5
+ class StreamSpeed extends node_events_1.EventEmitter {
6
6
  /**
7
7
  * Emits speed for a group of streams.
8
- *
9
- * @constructor
10
- * @extends {EventEmitter}
11
- * @param {Object?} options
12
- * @param {number?} options.timeUnit The time unit speed will be measured in.
13
- * @param {number?} options.range Time in ms to calculate speed over.
14
8
  */
15
9
  constructor(options = {}) {
16
10
  super();
@@ -22,12 +16,9 @@ class StreamSpeed extends events_1.EventEmitter {
22
16
  }
23
17
  /**
24
18
  * Updates the group with the latest change in speed.
25
- *
26
- * @param {Readable} origstream
27
- * @param {number} speed
28
19
  */
29
20
  _update(origstream, speed) {
30
- for (let [stream, m] of this._streams) {
21
+ for (const [stream, m] of this._streams) {
31
22
  // Skip own stream.
32
23
  if (stream === origstream) {
33
24
  continue;
@@ -39,16 +30,12 @@ class StreamSpeed extends events_1.EventEmitter {
39
30
  }
40
31
  /**
41
32
  * Convenient method that returns list of streams in this group.
42
- *
43
- * @return {Array.<Readable>}
44
33
  */
45
34
  getStreams() {
46
35
  return Array.from(this._streams.keys());
47
36
  }
48
37
  /**
49
38
  * Add stream to group.
50
- *
51
- * @param {Readable} stream
52
39
  */
53
40
  add(origstream) {
54
41
  // Check if stream is already in group.
@@ -69,7 +56,7 @@ class StreamSpeed extends events_1.EventEmitter {
69
56
  this._streams.delete(origstream);
70
57
  };
71
58
  const reader = new speedometer_1.Speedometer(this.options);
72
- const stream = origstream.pipe(new stream_1.PassThrough());
59
+ const stream = origstream.pipe(new node_stream_1.PassThrough());
73
60
  this._streams.set(origstream, {
74
61
  speedo: reader,
75
62
  cleanup,
@@ -80,8 +67,6 @@ class StreamSpeed extends events_1.EventEmitter {
80
67
  }
81
68
  /**
82
69
  * Remove stream from group.
83
- *
84
- * @param {Readable} stream
85
70
  */
86
71
  remove(stream) {
87
72
  // Check if stream is in group.
@@ -95,13 +80,10 @@ class StreamSpeed extends events_1.EventEmitter {
95
80
  * Get current speed across all streams.
96
81
  */
97
82
  getSpeed() {
98
- return Array.from(this._streams.values())
99
- .reduce((sum, meta) => sum + meta.speedo.getSpeed(), 0);
83
+ return Array.from(this._streams.values()).reduce((sum, meta) => sum + meta.speedo.getSpeed(), 0);
100
84
  }
101
85
  /**
102
86
  * Get an individual stream's speed.
103
- *
104
- * @param {Readable} stream
105
87
  */
106
88
  getStreamSpeed(stream) {
107
89
  const meta = this._streams.get(stream);
@@ -113,22 +95,25 @@ class StreamSpeed extends events_1.EventEmitter {
113
95
  /**
114
96
  * Converts bytes to human readable unit.
115
97
  * Thank you Amir from StackOverflow.
116
- *
117
- * @param {number} bytes
118
- * @param {Object} options
119
- * @param {string} options.timeUnit
120
- * @param {number?} options.precision
121
- * @return {string}
122
98
  */
123
99
  static toHuman(bytes, options = {}) {
124
100
  const units = ' KMGTPEZYXWVU';
125
- let timeUnit = options.timeUnit ? '/' + options.timeUnit : '';
126
- let t2 = bytes > 0 ?
127
- Math.min(Math.floor(Math.log(bytes) / Math.log(1024)), 12) : 0;
128
- let rate = Math.round(bytes * 100 / Math.pow(1024, t2)) / 100;
129
- let prate = options.precision ? rate.toPrecision(options.precision) : rate;
130
- return prate + units.charAt(t2).replace(' ', '') + 'B' + timeUnit;
101
+ const timeUnit = options.timeUnit ? `/${options.timeUnit}` : '';
102
+ const t2 = bytes > 0
103
+ ? Math.min(Math.floor(Math.log(bytes) / Math.log(1024)), 12)
104
+ : 0;
105
+ const rate = Math.round((bytes * 100) / Math.pow(1024, t2)) / 100;
106
+ const prate = options.precision
107
+ ? rate.toPrecision(options.precision)
108
+ : rate;
109
+ return `${prate + units.charAt(t2).replace(' ', '')}B${timeUnit}`;
131
110
  }
132
111
  }
112
+ StreamSpeed.StreamSpeed = StreamSpeed;
113
+ StreamSpeed.default = StreamSpeed;
114
+ // Statically recognizable exports for Node.js cjs-module-lexer (ESM named import support)
115
+ module.exports = StreamSpeed;
116
+ module.exports.default = StreamSpeed;
117
+ module.exports.StreamSpeed = StreamSpeed;
133
118
  module.exports = StreamSpeed;
134
119
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,mCAAsC;AACtC,mCAA+C;AAC/C,+CAAqD;AAgBrD,MAAM,WAAY,SAAQ,qBAAY;IAOpC;;;;;;;;OAQG;IACH,YAAY,OAAO,GAAG,EAAE;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,IAAI;SACZ,EAAE,OAAO,CAAC,CAAC;QACZ,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;IAC5B,CAAC;IAGD;;;;;OAKG;IACH,OAAO,CAAC,UAAoB,EAAE,KAAa;QACzC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;YACrC,mBAAmB;YACnB,IAAI,MAAM,KAAK,UAAU,EAAE;gBACzB,SAAS;aACV;YAED,sCAAsC;YACtC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;SAC9B;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAGD;;;;OAIG;IACH,UAAU;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAGD;;;;OAIG;IACH,GAAG,CAAC,UAAoB;QACtB,uCAAuC;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YACjC,MAAM,KAAK,CAAC,yBAAyB,CAAC,CAAC;SACxC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACrD,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,IAAI,EAAE;gBACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC9C,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACtC,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,oBAAW,EAAE,CAAC,CAAC;QAElD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE;YAC5B,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAClC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QACvD,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAGD;;;;OAIG;IACH,MAAM,CAAC,MAAgB;QACrB,+BAA+B;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC1C;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAGD;;OAEG;IACH,QAAQ;QACN,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;aACtC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;IAGD;;;;OAIG;IACH,cAAc,CAAC,MAAgB;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC1C;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAGD;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAO,CAAC,KAAa,EAAE,UAAsC,EAAE;QACpE,MAAM,KAAK,GAAG,eAAe,CAAC;QAC9B,IAAI,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjE,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC;QAC9D,IAAI,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3E,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC;IACpE,CAAC;CACF;AAED,iBAAS,WAAW,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,6CAA2C;AAC3C,6CAAyD;AACzD,+CAA0D;AAc1D,MAAM,WAAY,SAAQ,0BAAY;IAapC;;OAEG;IACH,YAAY,OAAO,GAAG,EAAE;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAC1B;YACE,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,IAAI;SACZ,EACD,OAAO,CACR,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,UAAoB,EAAE,KAAa;QACzC,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACxC,mBAAmB;YACnB,IAAI,MAAM,KAAK,UAAU,EAAE,CAAC;gBAC1B,SAAS;YACX,CAAC;YAED,sCAAsC;YACtC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,UAAoB;QACtB,uCAAuC;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACrD,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC9C,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACtC,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,yBAAW,EAAE,CAAC,CAAC;QAElD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE;YAC5B,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAClC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QACvD,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAgB;QACrB,+BAA+B;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC9C,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAC3C,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAgB;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,KAAa,EAAE,UAAsC,EAAE;QACpE,MAAM,KAAK,GAAG,eAAe,CAAC;QAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,MAAM,EAAE,GACN,KAAK,GAAG,CAAC;YACP,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;YAC5D,CAAC,CAAC,CAAC,CAAC;QACR,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,SAAA,IAAI,EAAI,EAAE,CAAA,CAAC,GAAG,GAAG,CAAC;QAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS;YAC7B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC;QACT,OAAO,GAAG,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,QAAQ,EAAE,CAAC;IACpE,CAAC;;AAzIM,uBAAW,GAAG,WAAW,CAAC;AAC1B,mBAAO,GAAG,WAAW,CAAC;AA2I/B,0FAA0F;AAC1F,MAAM,CAAC,OAAO,GAAG,WAAW,CAAC;AAC7B,MAAM,CAAC,OAAO,CAAC,OAAO,GAAG,WAAW,CAAC;AACrC,MAAM,CAAC,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAEzC,iBAAS,WAAW,CAAC"}
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  export interface Options {
3
2
  timeUnit?: number;
4
3
  range?: number;
@@ -9,18 +8,10 @@ export declare class Speedometer {
9
8
  private _lastSpeed;
10
9
  /**
11
10
  * Helps count the number of bytes per data event in streams.
12
- *
13
- * @constructor
14
- * @param {Object?} options
15
- * @param {number?} options.timeUnit
16
- * @param {number?} options.range
17
11
  */
18
12
  constructor(options: Options);
19
13
  /**
20
14
  * Called when new data arrives.
21
- *
22
- * @param {Buffer|string} data
23
- * @param {Function} callback
24
15
  */
25
16
  update(data: Buffer, callback: (speed: number) => void): void;
26
17
  /**
@@ -1,13 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Speedometer = void 0;
3
4
  class Speedometer {
4
5
  /**
5
6
  * Helps count the number of bytes per data event in streams.
6
- *
7
- * @constructor
8
- * @param {Object?} options
9
- * @param {number?} options.timeUnit
10
- * @param {number?} options.range
11
7
  */
12
8
  constructor(options) {
13
9
  this.options = options;
@@ -16,9 +12,6 @@ class Speedometer {
16
12
  }
17
13
  /**
18
14
  * Called when new data arrives.
19
- *
20
- * @param {Buffer|string} data
21
- * @param {Function} callback
22
15
  */
23
16
  update(data, callback) {
24
17
  const now = Date.now();
@@ -26,7 +19,7 @@ class Speedometer {
26
19
  speed: data.length,
27
20
  time: now,
28
21
  });
29
- let speed = this.getSpeed();
22
+ const speed = this.getSpeed();
30
23
  const change = this._lastSpeed !== speed;
31
24
  this._lastSpeed = speed;
32
25
  // Only emit event if there is a change in speed.
@@ -38,16 +31,15 @@ class Speedometer {
38
31
  * Gets current speed.
39
32
  */
40
33
  getSpeed() {
41
- let now = Date.now();
34
+ const now = Date.now();
42
35
  if (this.history.length) {
43
36
  // Remove old data events.
44
- let index = this.history
45
- .findIndex(item => item.time > now - this.options.range);
37
+ const index = this.history.findIndex((item) => item.time > now - this.options.range);
46
38
  this.history = index > -1 ? this.history.slice(index) : [];
47
39
  }
48
40
  // Get total data emitted in `range` time period.
49
- let totaldata = this.history.reduce((sum, point) => point.speed + sum, 0);
50
- let speed = Math.round(totaldata / this.options.range * this.options.timeUnit);
41
+ const totaldata = this.history.reduce((sum, point) => point.speed + sum, 0);
42
+ const speed = Math.round((totaldata / this.options.range) * this.options.timeUnit);
51
43
  return speed;
52
44
  }
53
45
  }
@@ -1 +1 @@
1
- {"version":3,"file":"speedometer.js","sourceRoot":"","sources":["../src/speedometer.ts"],"names":[],"mappings":";;AAUA,MAAa,WAAW;IAItB;;;;;;;OAOG;IACH,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;IACtB,CAAC;IAGD;;;;;OAKG;IACH,MAAM,CAAC,IAAY,EAAE,QAAiC;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YAChB,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,IAAI,EAAE,GAAG;SACV,CAAC,CAAC;QAEH,IAAI,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAExB,iDAAiD;QACjD,IAAI,MAAM,EAAE;YACV,QAAQ,CAAC,KAAK,CAAC,CAAC;SACjB;IACH,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACrB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACvB,0BAA0B;YAC1B,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO;iBACrB,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC3D,IAAI,CAAC,OAAO,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5D;QAED,iDAAiD;QACjD,IAAI,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;QAC1E,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CACpB,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CACvD,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA/DD,kCA+DC"}
1
+ {"version":3,"file":"speedometer.js","sourceRoot":"","sources":["../src/speedometer.ts"],"names":[],"mappings":";;;AAUA,MAAa,WAAW;IAItB;;OAEG;IACH,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY,EAAE,QAAiC;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YAChB,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,IAAI,EAAE,GAAG;SACV,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAExB,iDAAiD;QACjD,IAAI,MAAM,EAAE,CAAC;YACX,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,0BAA0B;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAClC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAC/C,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,CAAC;QAED,iDAAiD;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CACtB,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CACzD,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAvDD,kCAuDC"}
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "stream",
6
6
  "speed"
7
7
  ],
8
- "version": "2.0.1",
8
+ "version": "2.0.3",
9
9
  "repository": {
10
10
  "type": "git",
11
11
  "url": "git://github.com/fent/node-streamspeed.git"
@@ -18,24 +18,25 @@
18
18
  "scripts": {
19
19
  "prepare": "tsc -p tsconfig.build.json",
20
20
  "build": "tsc -p tsconfig.build.json",
21
+ "lint": "biome check .",
22
+ "lint:fix": "biome check --write .",
21
23
  "test": "nyc --extension .ts --reporter=lcov --reporter=text-summary npm run test:unit",
22
24
  "test:unit": "mocha --require ts-node/register test/*-test.ts"
23
25
  },
24
- "directories": {
25
- "lib": "./lib"
26
- },
27
26
  "devDependencies": {
28
- "@types/mocha": "^7.0.2",
29
- "@types/node": "^13.11.1",
30
- "@types/sinon": "^9.0.0",
31
- "mocha": "^5.1.1",
32
- "nyc": "^15.0.1",
33
- "sinon": "^6.0.0",
34
- "ts-node": "^8.8.2",
35
- "typescript": "^3.8.3"
27
+ "@biomejs/biome": "2.5.15",
28
+ "@types/mocha": "^10.0.10",
29
+ "@types/node": "^20.1.2",
30
+ "@types/sinon": "^22.0.1",
31
+ "mocha": "^12.0.3",
32
+ "nyc": "^18.0.0",
33
+ "sinon": "^22.1.0",
34
+ "ts-node": "^10.9.2",
35
+ "typescript": "^5.6.3"
36
36
  },
37
37
  "engines": {
38
- "node": ">=10"
38
+ "node": ">=20"
39
39
  },
40
+ "sideEffects": false,
40
41
  "license": "MIT"
41
42
  }