@cjser/noop-stream 1.0.0-cjser.2

package/dist-cjser/index.cjs

@@ -0,0 +1,63 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/noop-stream.tmp-26-1778153739280/index.js
+var index_exports = {};
+__export(index_exports, {
+  readableNoopStream: () => readableNoopStream,
+  writableNoopStream: () => writableNoopStream
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_stream = require("node:stream");
+var import_node_buffer = require("node:buffer");
+function readableNoopStream({ size = 0, ...options } = {}) {
+  let producedSize = 0;
+  return new import_node_stream.Readable({
+    ...options,
+    read(readSize) {
+      let shouldEnd = false;
+      if (producedSize + readSize >= size) {
+        readSize = size - producedSize;
+        shouldEnd = true;
+      }
+      setImmediate(() => {
+        if (size === 0) {
+          this.push(null);
+        }
+        producedSize += readSize;
+        this.push(import_node_buffer.Buffer.alloc(readSize));
+        if (shouldEnd) {
+          this.push(null);
+        }
+      });
+    }
+  });
+}
+function writableNoopStream(options) {
+  return new import_node_stream.Writable({
+    ...options,
+    write(chunk, encding, callback) {
+      setImmediate(callback);
+    }
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  readableNoopStream,
+  writableNoopStream
+});

package/index.d.ts

@@ -0,0 +1,43 @@
+import {
+	ReadableOptions as ReadableNodeStreamOptions,
+	WritableOptions as WritableNodeStreamOptions,
+} from 'node:stream';
+
+export interface ReadableStreamOptions extends Omit<ReadableNodeStreamOptions, 'read'> {
+	/**
+	The amount of data to stream in bytes.
+
+	Set it to `Infinity` to make it produce data until you manually destroy the stream.
+
+	@default 0
+	*/
+	readonly size?: number;
+}
+
+export interface WritableStreamOptions extends Omit<WritableNodeStreamOptions, 'write'> {}
+
+/**
+Create a readable Node.js stream that produces no data (or optionally blank data).
+
+@example
+```
+import stream from 'stream';
+import {readableNoopStream} from '@cjser/noop-stream';
+
+stream.pipeline(readableNoopStream({size: 10}), process.stdout);
+```
+*/
+export function readableNoopStream(options?: ReadableStreamOptions): NodeJS.ReadableStream;
+
+/**
+Create a writable Node.js stream that discards received data.
+
+@example
+```
+import stream from 'stream';
+import {writableNoopStream} from '@cjser/noop-stream';
+
+stream.pipeline(process.stdin, writableNoopStream());
+```
+*/
+export function writableNoopStream(options?: WritableStreamOptions): NodeJS.WritableStream;

package/index.js

@@ -0,0 +1,43 @@
+import {
+	Readable as ReadableStream,
+	Writable as WritableStream,
+} from 'node:stream';
+import {Buffer} from 'node:buffer';
+
+export function readableNoopStream({size = 0, ...options} = {}) {
+	let producedSize = 0;
+
+	return new ReadableStream({
+		...options,
+		read(readSize) {
+			let shouldEnd = false;
+
+			if ((producedSize + readSize) >= size) {
+				readSize = size - producedSize;
+				shouldEnd = true;
+			}
+
+			setImmediate(() => {
+				if (size === 0) {
+					this.push(null);
+				}
+
+				producedSize += readSize;
+				this.push(Buffer.alloc(readSize));
+
+				if (shouldEnd) {
+					this.push(null);
+				}
+			});
+		},
+	});
+}
+
+export function writableNoopStream(options) {
+	return new WritableStream({
+		...options,
+		write(chunk, encding, callback) {
+			setImmediate(callback);
+		},
+	});
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@cjser/noop-stream",
+  "version": "1.0.0-cjser.2",
+  "description": "Create a readable Node.js stream that produces no data (or optionally blank data) or a writable stream that discards data",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    "require": "./dist-cjser/index.cjs",
+    "default": "./index.js"
+  },
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "stream",
+    "readable",
+    "writable",
+    "readablestream",
+    "writablestream",
+    "noop",
+    "empty",
+    "dev",
+    "null",
+    "devnull",
+    "blank",
+    "drain",
+    "test",
+    "testing",
+    "fixture"
+  ],
+  "devDependencies": {
+    "@types/node": "^16.10.9",
+    "ava": "^3.15.0",
+    "get-stream": "^6.0.1",
+    "tsd": "^0.18.0",
+    "xo": "^0.45.0"
+  },
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "1.0.0",
+    "cjserVersion": 2,
+    "original": {
+      "name": "noop-stream",
+      "version": "1.0.0",
+      "exports": "./index.js",
+      "repository": "sindresorhus/noop-stream",
+      "files": [
+        "index.js",
+        "index.d.ts"
+      ],
+      "scripts": {
+        "test": "xo && ava && tsd"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,55 @@
+# noop-stream
+
+> Create a readable Node.js stream that produces no data (or optionally blank data) or a writable stream that discards data
+
+This can be useful for testing, fixtures, draining a stream, etc. [(Example)](https://github.com/sindresorhus/file-type/commit/7d14761b757912bccc464fc3fb86398f2a533999)
+
+It's like `fs.createReadStream('/dev/null')` but cross-platform.
+
+## Install
+
+```sh
+npm install noop-stream
+```
+
+## Usage
+
+```js
+import stream from 'stream';
+import {readableNoopStream} from 'noop-stream';
+
+stream.pipeline(readableNoopStream({size: 10}), process.stdout);
+```
+
+```js
+import stream from 'stream';
+import {writableNoopStream} from 'noop-stream';
+
+stream.pipeline(process.stdin, writableNoopStream());
+```
+
+## API
+
+### readableNoopStream(options?)
+
+Create a readable Node.js stream that produces no data (or optionally blank data).
+
+Options are passed to the [`stream.Readable` constructor](https://nodejs.org/api/stream.html#stream_new_stream_readable_options), except for the `read` option.
+
+You can also specify a `size` option, which is the size in bytes to produce. By default, it's `0`. Set it to `Infinity` to make it produce data until you manually destroy the stream.
+
+### writableNoopStream(options?)
+
+Create a writable Node.js stream that discards received data.
+
+Options are passed to the [`stream.Writable` constructor](https://nodejs.org/api/stream.html#stream_constructor_new_stream_writable_options), except for the `write` option.
+
+## Related
+
+- [dev-null-cli](https://github.com/sindresorhus/dev-null-cli) - Cross-platform `/dev/null`
+- [random-bytes-readable-stream](https://github.com/sindresorhus/random-bytes-readable-stream) - Creates a readable stream producing cryptographically strong pseudo-random data
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/noop-stream