commit d0b5a86a86c756ac9bfe7e887a34378cb1e1c7cd Author: Sven Slootweg Date: Sat May 4 21:18:54 2019 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..97008e5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +yarn.lock \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c1f44b --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# @ppstreams/propagate-peek + +A simple peek handler for ppstreams that just passes on an incoming peek request to the direct upstream. + +## Example: + +```js +"use strict"; + +const propagateAbort = require("@ppstreams/propagate-abort"); +const propagatePeek = require("@ppstreams/propagate-peek"); + +module.exports = function makeStream() { + return { + description: `pass-through stream`, + read: (source) => { + /* This example stream just passes through the upstream value */ + return source.read(); + }, + abort: propagateAbort, + peek: propagatePeek + } +}; +``` \ No newline at end of file diff --git a/index.js b/index.js new file mode 100644 index 0000000..f340b9f --- /dev/null +++ b/index.js @@ -0,0 +1,5 @@ +"use strict"; + +module.exports = function propagatePeek(source) { + return source.peek(); +}; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..bb12043 --- /dev/null +++ b/package.json @@ -0,0 +1,8 @@ +{ + "name": "@ppstreams/propagate-peek", + "version": "0.1.0", + "main": "index.js", + "repository": "http://git.cryto.net/ppstreams/propagate-peek.git", + "author": "Sven Slootweg ", + "license": "WTFPL OR CC0-1.0" +}