@ppstreams/end-of-stream-marker

A simple custom error type for marking the end of a ppstreams stream. 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 module, which is a source stream that produces numbers within a range:

1"use strict";
2
3const simpleSource = require("@ppstreams/simple-source");
4const EndOfStream = require("@ppstreams/end-of-stream");
5
6module.exports = function rangeNumbers(start, end, step = 1) {
7	let i = start;
8
9	return simpleSource({
10		onRequest: () => {
11			if (i >= end) {
12				throw new EndOfStream();
13			} else {
14				let number = i;
15				i += step;
16				return number;
17			}
18		}
19	});
20}

API

EndOfStream()

A custom Error constructor, that produces an 'end of stream' marker; that is, a special kind of error to signal that the end of the source stream has been reached, and no further values should be requested.

Takes no arguments.