Update to new name

master
Sven Slootweg 4 years ago
parent 44d27c86ff
commit ac5102fc00

@ -1,7 +1,7 @@
# @ppstreams/aborted-marker
# @promistream/aborted
__Note:__ This documentation is incomplete.
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 custom 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 custom source stream.
If you just want a stream that produces a value every time one is requested, and that doesn't need to clean up any external resources like file handles or network connections, use the [simple-source](https://www.npmjs.com/package/@ppstreams/simple-source) module instead.
If you just want a stream that produces a value every time one is requested, and that doesn't need to clean up any external resources like file handles or network connections, use the [simple-source](https://www.npmjs.com/package/@promistream/simple-source) module instead.

@ -2,6 +2,8 @@
const Aborted = require("./");
// TODO: Turn this into a meaningful example
let marker = new Aborted();
console.log(marker); // Logs the new Aborted (Error) instance

@ -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("Aborted", {
populate: (message) => {
return { message: defaultValue(message, "The stream was aborted") };
},
context: {
__ppstreams_isAbortedMarker: true,
__ppstreams_specVersion: 1
_promistreamIsAbortedMarker: true,
_promistreamVersion: 1
}
});

@ -1,8 +1,8 @@
{
"name": "@ppstreams/aborted",
"name": "@promistream/aborted",
"version": "0.1.1",
"main": "index.js",
"repository": "http://git.cryto.net/ppstreams/aborted.git",
"repository": "http://git.cryto.net/promistream/aborted.git",
"author": "Sven Slootweg <admin@cryto.net>",
"license": "WTFPL OR CC0-1.0",
"dependencies": {

Loading…
Cancel
Save