Update to new name
This commit is contained in:
parent
99cfa7e688
commit
b71f1e8b7f
18
README.md
18
README.md
|
@ -1,19 +1,19 @@
|
|||
# @ppstreams/end-of-stream-marker
|
||||
# @promistream/end-of-stream
|
||||
|
||||
<!-- FIXME: Uncomment the below when 1.0.0 is hit -->
|
||||
<!-- __This module is compatible with the [ppstreams](https://ppstreams.cryto.net/) standard, version 1.0.0 - the latest at the time of writing.__ -->
|
||||
<!-- __This module is compatible with the [Promistream](https://promistream.cryto.net/) standard, version 1.0.0 - the latest at the time of writing.__ -->
|
||||
|
||||
A simple custom error type for marking the end of a [ppstreams](https://ppstreams.cryto.net/) stream. You'd usually only need this module when you're implementing a source stream.
|
||||
A simple custom error type for marking the end of a [Promistream](https://promistream.cryto.net/). You'd usually only need this module when you're implementing a source stream.
|
||||
|
||||
## Example
|
||||
|
||||
An example of *producing* an `EndOfStream` marker, from the [range-numbers](https://www.npmjs.com/package/@ppstreams/range-numbers) module, which is a source stream that produces numbers within a range:
|
||||
An example of *producing* an `EndOfStream` marker, from the [range-numbers](https://www.npmjs.com/package/@promistream/range-numbers) module, which is a source stream that produces numbers within a range:
|
||||
|
||||
```js
|
||||
"use strict";
|
||||
|
||||
const simpleSource = require("@ppstreams/simple-source");
|
||||
const EndOfStream = require("@ppstreams/end-of-stream");
|
||||
const simpleSource = require("@promistream/simple-source");
|
||||
const EndOfStream = require("@promistream/end-of-stream");
|
||||
|
||||
module.exports = function rangeNumbers(start, end, step = 1) {
|
||||
let i = start;
|
||||
|
@ -33,14 +33,14 @@ module.exports = function rangeNumbers(start, end, step = 1) {
|
|||
```
|
||||
|
||||
<!-- FIXME: Move below to is-end-of-stream and link from here, also update the example code to use the newer APIs
|
||||
An example of *detecting* an `EndOfStream` marker, from the [simple-sink](https://git.cryto.net/ppstreams/simple-sink) module, which just keeps pulling values until the end of the stream:
|
||||
An example of *detecting* an `EndOfStream` marker, from the [simple-sink](https://git.cryto.net/promistream/simple-sink) module, which just keeps pulling values until the end of the stream:
|
||||
|
||||
```js
|
||||
"use strict";
|
||||
|
||||
const Promise = require("bluebird");
|
||||
const propagateAbort = require("@ppstreams/propagate-abort");
|
||||
const { isEndOfStream } = require("@ppstreams/is-end-of-stream");
|
||||
const propagateAbort = require("@promistream/propagate-abort");
|
||||
const { isEndOfStream } = require("@promistream/is-end-of-stream");
|
||||
|
||||
module.exports = function greedySinkStream(description, callback) {
|
||||
return {
|
||||
|
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
const EndOfStream = require("./");
|
||||
|
||||
// TODO: Turn this into a meaningful example
|
||||
|
||||
let marker = new EndOfStream();
|
||||
|
||||
console.log(marker); // Logs the new EndOfStream (Error) instance
|
||||
|
|
5
index.js
5
index.js
|
@ -3,13 +3,12 @@
|
|||
const createError = require("error-chain").create;
|
||||
const defaultValue = require("default-value");
|
||||
|
||||
// FIXME: Update everything that uses end-of-stream-marker or aborted-marker to the new split-module API
|
||||
module.exports = createError("EndOfStream", {
|
||||
populate: (message) => {
|
||||
return { message: defaultValue(message, "There is no more data to read") };
|
||||
},
|
||||
context: {
|
||||
__ppstreams_isEndOfStreamMarker: true,
|
||||
__ppstreams_specVersion: 1
|
||||
_promistreamIsEndOfStreamMarker: true,
|
||||
_promistreamVersion: 1
|
||||
}
|
||||
});
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"name": "@ppstreams/end-of-stream",
|
||||
"name": "@promistream/end-of-stream",
|
||||
"version": "0.1.1",
|
||||
"main": "index.js",
|
||||
"repository": "http://git.cryto.net/ppstreams/end-of-stream.git",
|
||||
"repository": "http://git.cryto.net/promistream/end-of-stream.git",
|
||||
"author": "Sven Slootweg <admin@cryto.net>",
|
||||
"license": "WTFPL OR CC0-1.0",
|
||||
"dependencies": {
|
||||
|
|
Loading…
Reference in a new issue