@farar/nodes
Advanced tools
@farar/nodes - npm Package Compare versions
Comparing version 1.0.2 to 1.0.3
| { | ||
| "name": "@farar/nodes", | ||
| "version": "1.0.2", | ||
| "version": "1.0.3", | ||
| "description": "", | ||
@@ -5,0 +5,0 @@ "main": "./dist/index.js", |
@@ -16,3 +16,3 @@ # Nodes | ||
| ## Table of Contents | ||
| ## Table of contents | ||
@@ -25,4 +25,4 @@ - [Installation](#installation) | ||
| - [Backpressure](#backpressure) | ||
| - [Best Practices](#best-practices) | ||
| - [Error Handling](#error-handling) | ||
| - [Best practices](#best-practices) | ||
| - [Error handling](#error-handling) | ||
| - [Versioning](#versioning) | ||
@@ -46,3 +46,3 @@ - [Test](#test) | ||
| ### _A Graph API Pattern Logger Implementation_ <sup><sup>\</example\></sup></sup> | ||
| ### _A graph API pattern logger implementation_ <sup><sup>\</example\></sup></sup> | ||
@@ -53,3 +53,3 @@ Please see the [_Streams_ Logger](https://github.com/faranalytics/streams-logger) implementation. | ||
| ### The Node Class | ||
| ### The Node class | ||
@@ -83,3 +83,3 @@ #### new nodes.Node\<InT, OutT\>(stream, options) | ||
| ### The Nodes Config Settings Object | ||
| ### The Nodes Config settings object | ||
@@ -92,3 +92,3 @@ **Config.errorHandler** `<ErrorHandler>` An optional error handler. **Default: `console.error`** | ||
| ### How to Implement a Data Transformation Node | ||
| ### How to implement a data transformation node | ||
@@ -135,3 +135,3 @@ In order to implement a data transformation `Node`, extend the `Node` class and pass a Node.js `stream.Writable` implementation to the super's constructor. | ||
| ### How to Consume a Readable, Writable, Duplex, or Transform Node.js Stream | ||
| ### How to consume a Readable, Writable, Duplex, or Transform Node.js stream | ||
@@ -156,3 +156,3 @@ In this hypothetical example a type-safe `Node` is constructed from a `net.Socket`. The resulting `Node` instance can be used in a data transformation graph. | ||
| ## Best Practices | ||
| ## Best practices | ||
@@ -163,3 +163,3 @@ ### Avoid reuse of `Node` instances (_unless you know what you are doing!_). | ||
| ## Error Handling | ||
| ## Error handling | ||
@@ -170,3 +170,3 @@ Nodes may be used in diverse contexts, each with unique requirements. Nodes _should_ never throw if the API is used in accordance with the documentation. However, "_phenomena happens_"; hence, you may choose to handle errors accordingly! | ||
| ### Optionally configure all internal `Node` errors to be thrown. | ||
| ### Optionally configure all internal errors to be thrown | ||
@@ -196,5 +196,5 @@ ```ts | ||
| ### Instructions | ||
| ### How to run the test | ||
| Clone the repository. | ||
| #### Clone the repository. | ||
@@ -205,3 +205,3 @@ ```bash | ||
| Change directory into the root of the repository. | ||
| #### Change directory into the root of the repository. | ||
@@ -212,3 +212,3 @@ ```bash | ||
| Install dependencies. | ||
| #### Install dependencies. | ||
@@ -219,3 +219,3 @@ ```bash | ||
| Run the tests. | ||
| #### Run the tests. | ||
@@ -228,4 +228,4 @@ ```bash | ||
| If you have a feature request or run into any issues, feel free to submit an [issue](https://github.com/faranalytics/nodes/issues) or start a [discussion](https://github.com/faranalytics/nodes/discussions). You’re also welcome to reach out directly to one of the authors at any time. | ||
| If you have a feature request or run into any issues, feel free to submit an [issue](https://github.com/faranalytics/nodes/issues) or start a [discussion](https://github.com/faranalytics/nodes/discussions). You’re also welcome to reach out directly to one of the authors. | ||
| - [Adam Patterson](https://github.com/adamjpatterson) |
Improved metrics
- Total package byte prevSize
- increased by0.01%
58327