From ac5102fc00c5cc2a4eb6d319840a32befddbd849 Mon Sep 17 00:00:00 2001 From: Sven Slootweg Date: Tue, 9 Feb 2021 23:26:11 +0100 Subject: [PATCH] Update to new name --- README.md | 6 +++--- example.js | 2 ++ index.js | 5 ++--- package.json | 4 ++-- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 74b223e..a9b91ae 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/example.js b/example.js index 9f51091..0fb09a9 100644 --- a/example.js +++ b/example.js @@ -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 diff --git a/index.js b/index.js index f9cf001..32654b9 100644 --- a/index.js +++ b/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("Aborted", { populate: (message) => { return { message: defaultValue(message, "The stream was aborted") }; }, context: { - __ppstreams_isAbortedMarker: true, - __ppstreams_specVersion: 1 + _promistreamIsAbortedMarker: true, + _promistreamVersion: 1 } }); diff --git a/package.json b/package.json index 49180e3..b28ca97 100644 --- a/package.json +++ b/package.json @@ -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 ", "license": "WTFPL OR CC0-1.0", "dependencies": {