pull-stream - npm Package Compare versions

Comparing version 2.22.0 to 2.22.2

docs/sinks.md

@@ -1,6 +0,5 @@
-
 # Sinks
 
-A Source is a stream that is not readable.
-You *must* have a source at the start of a pipeline
+A Sink is a stream that is not readable.
+You *must* have a sink at the end of a pipeline
 for data to move through.
@@ -16,2 +15,6 @@
 
+See also:
+* [Sources](https://github.com/dominictarr/pull-stream/blob/master/docs/sources.md)
+* [Throughs](https://github.com/dominictarr/pull-stream/blob/master/docs/throughs.md)
+
 ## drain (op?, done?)
@@ -18,0 +21,0 @@

docs/sources.md

@@ -15,2 +15,6 @@ # Sources
 
+See also:
+* [Throughs](https://github.com/dominictarr/pull-stream/blob/master/docs/throughs.md)
+* [Sinks](https://github.com/dominictarr/pull-stream/blob/master/docs/sinks.md)
+
 ## values (array | object)
@@ -17,0 +21,0 @@

docs/throughs.md

@@ -8,6 +8,6 @@ # Throughs
 
-Put through streams in-between sources and sinks,
+Put through streams in-between [sources](https://github.com/dominictarr/pull-stream/blob/master/docs/sources.md) and [sinks](https://github.com/dominictarr/pull-stream/blob/master/docs/sinks.md),
 like this:
 
-``` js
+```js
 source()
@@ -22,3 +22,3 @@ .pipe(through()) //optional
 
-``` js
+```js
 var throughABC = function () {
@@ -33,13 +33,17 @@ return throughA()
 
-``` js
+```js
 source().pipe(throughABC()).pipe(sink())
 ```
 
+See also:
+* [Sources](https://github.com/dominictarr/pull-stream/blob/master/docs/sources.md)
+* [Sinks](https://github.com/dominictarr/pull-stream/blob/master/docs/sinks.md)
+
 ## map (fun)
 
-like `[].map(function (data) {return data})`
+Like `[].map(function (data) {return data})`
 
 ## asyncMap (fun)
 
-like `map` but the signature of `fun` must be
+Like `map` but the signature of `fun` must be
 `function (data, cb) { cb(null, data) }`
@@ -49,3 +53,3 @@
 
-like `[].filter(function (data) {return true || false})`
+Like `[].filter(function (data) {return true || false})`
 only `data` where `test(data) == true` are let through
@@ -57,3 +61,3 @@ to the next stream.
 
-like filter, but remove items where the filter returns true.
+Like filter, but remove items where the filter returns true.
 
@@ -68,3 +72,3 @@ ## unique (prop)
 
-filter unique items -- get the duplicates.
+Filter unique items -- get the duplicates.
 The inverse of `unique`
@@ -74,3 +78,3 @@
 
-read from the source stream until `test` fails.
+Read from the source stream until `test` fails.
 
@@ -90,3 +94,3 @@ ## group (length)
 
-A async buffering stream.
+An async buffering stream.
 
@@ -93,0 +97,0 @@ `highWaterMark` will eagerly read from the source stream,

package.json

 {
   "name": "pull-stream",
   "description": "minimal pull stream",
-  "version": "2.22.0",
+  "version": "2.22.2",
   "homepage": "https://github.com/dominictarr/pull-stream",
@@ -6,0 +6,0 @@ "repository": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

45531

decreased by-50.34%

Number of package files

31

decreased by-50.79%

Lines of code

1263

decreased by-50%

No dependency changes