propagate-peek/README.md

# @promistream/propagate-peek

A simple peek handler for [Promistreams](https://promistream.cryto.net/) that just passes on an incoming peek request to the direct upstream.

## Example:

```js
"use strict";

const propagateAbort = require("@promistream/propagate-abort");
const propagatePeek = require("@promistream/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
	}
};
```