continuous-streams - npm Package Compare versions

Comparing version 1.0.0-beta.10 to 1.0.0

package.json

 {
   "name": "continuous-streams",
-  "version": "1.0.0-beta.10",
+  "version": "1.0.0",
   "description": "Special purpose Node streams",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

 # Continuous Streams
 
-Stream classes with specific behaviour:
+Stream classes with specific behavior:
 
@@ -82,14 +82,6 @@ * continuous reading, i.e., it doesn't stop if there is temporarily no data available
 
-For this module to work, your TypeScript compiler options must include:
+For this module to work, your **TypeScript compiler options** must include
+`"target": "ES2015"` (or later), `"moduleResolution": "node"`, and
+`"esModuleInterop": true`.
 
-```json
-{
-  "compilerOptions": {
-    "target": "ES2015", // or later
-    "moduleResolution": "node",
-    "esModuleInterop": true
-  }
-}
-```
-
 ## Stream Classes
@@ -105,3 +97,3 @@
 
-**Options**
+#### Options
 
@@ -114,3 +106,3 @@ * `chunkSize` - Whenever the number of objects in the internal buffer is dropping below `chunkSize`, a new chunk of data is read from the underlying resource. Higher means fewer polling but less real-time. Default is `50`.
 
-**Methods**
+#### Methods
 
@@ -120,3 +112,3 @@ * `readData(count)` -- An asynchronous method to read `count` data items from the underlying resource. To be implemented or assigned. `count` is usually equals `chunkSize`. It resolves with an array of data items -- which may be empty if there is temporarily no data available. If it rejects, an `error` or `skip` event is emitted (depending on `skipOnError`).
 
-**Events**
+#### Events
 
@@ -138,3 +130,3 @@ * `skip` - When reading from the underlying resource failed (if `skipOnError` is `true`). The stream continues to read after a delay of `waitAfterError`. Example handler: `reader.on('skip', ({ error }) => { ... })`.
 
-**Options**
+#### Options
 
@@ -145,7 +137,7 @@ * `parallelOps` - The max number of asynchronous `writeData()` operations to fire off in parallel. Default is `10`.
 
-**Methods**
+#### Methods
 
 * `writeData(item)` -- An asynchronous method to process a single data item. To be implemented or assigned. If it rejects, an `error` or `skip` event is emitted (depending on `skipOnError`).
 
-**Events**
+#### Events
 
@@ -156,3 +148,3 @@ * `skip` - If `skipOnError` is `true` (default). Example handler: `writer.on('skip', ({ data, error }) => { ... })`.
 * `close` - After `error` or `finish` (as usual).
-* `debug` - After each successful write operation providing some debug information. Example handler: `writer.on('debug', ({ inflight, total, elapsed }) => { ... })`. `inflight` is the number of asynchroneous `writeData()` operations currenly inflight. `total` is an overall counter. `elapsed` is the number of milliseconds of `writeData()` to resolve.
+* `debug` - After each successful write operation providing some debug information. Example handler: `writer.on('debug', ({ inflight, total, elapsed }) => { ... })`. `inflight` is the number of asynchronous `writeData()` operations currently inflight. `total` is an overall counter. `elapsed` is the number of milliseconds of `writeData()` to resolve.
 
@@ -167,3 +159,3 @@ ### Class `ContinuousTransformer`
 
-**Options**
+#### Options
 
@@ -174,7 +166,7 @@ * `parallelOps` - The max number of asynchronous `transformData()` operations to fire off in parallel. Default is `10`.
 
-**Methods**
+#### Methods
 
 * `transformData(item)` -- An asynchronous method to process a single data item. Resolves with the transformed data item (or an array of items for splitting the item into multiple items). To be implemented or assigned. If it rejects, an `error` or `skip` event is emitted (depending on `skipOnError`).
 
-**Events**
+#### Events
 
@@ -184,2 +176,2 @@ * `skip` - If `skipOnError` is `true` (default). Example handler: `transformer.on('skip', ({ data, error }) => { ... })`.
 * `close` - When the stream is closed (as usual).
-* `debug` - After each successful transform operation providing some debug information. Example handler: `transformer.on('debug', ({ inflight, total, elapsed }) => { ... })`. `inflight` is the number of asynchroneous `transformData()` operations currenly inflight. `total` is an overall counter. `elapsed` is the number of milliseconds of `transformData()` to resolve.
+* `debug` - After each successful transform operation providing some debug information. Example handler: `transformer.on('debug', ({ inflight, total, elapsed }) => { ... })`. `inflight` is the number of asynchronous `transformData()` operations currently inflight. `total` is an overall counter. `elapsed` is the number of milliseconds of `transformData()` to resolve.

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

54211

decreased by-0.08%

Number of lines in readme file

168

decreased by-4.55%

No dependency changes