@push-stream-std/push-stdio (0.0.8)
Installation
@push-stream-std:registry=https://hub.kl1.tenere.ai/api/packages/push-stream-std/npm/npm install @push-stream-std/push-stdio@0.0.8"@push-stream-std/push-stdio": "0.0.8"About this package
@push-stream-std/push-stdio
stdin, stdout, and stderr as push-streams.
Published as @push-stream-std/push-stdio.
Synopsis
import stdin from '@push-stream-std/push-stdio/stdin';
import stdout from '@push-stream-std/push-stdio/stdout';
import stderr from '@push-stream-std/push-stdio/stderr';
stdin().pipe(stdout());
import { stdin, stdout, stderr } from '@push-stream-std/push-stdio';
stdin().pipe(processThrough).pipe(stdout());
Install
npm config set @push-stream-std:registry https://hub.kl1.tenere.ai/api/packages/push-stream-std/npm/
npm config set -- //hub.kl1.tenere.ai/api/packages/push-stream-std/npm/:_authToken "$PACKAGE_TOKEN"
npm install @push-stream-std/push-stdio
Why
Provides push-stream wrappers for process.stdin, process.stdout, and process.stderr. stdin is a source that reads from standard input in read mode using the Node.js readable stream API. stdout and stderr are sinks that write data to standard output and standard error respectively. All three are built on the push-stream-base primitives for canonical push-stream behavior.
API
stdin(options)
Returns a push-stream source backed by process.stdin.
- options
object(optional):- encoding
string(default'utf8') – Encoding passed toprocess.stdin.read(). - raw
boolean(defaultfalse) – If true, reads rawBufferchunks instead of decoded strings. When stdin is a TTY andrawis false, terminal raw mode is disabled. - highWatermark
number(default16384) – Reserved for future use.
- encoding
- Returns A push-stream source with
pipe(),resume(),abort(),paused,ended, andsink.
stdout(options)
Returns a push-stream sink backed by process.stdout.
- options
object(optional):- encoding
string(default'utf8') – Encoding used for string writes. - highWatermark
number(default16384) – Reserved for future use.
- encoding
- Returns A push-stream sink with
write(),end(),abort(),paused, andended.
stderr(options)
Returns a push-stream sink backed by process.stderr.
- options
object(optional):- encoding
string(default'utf8') – Encoding used for string writes.
- encoding
- Returns A push-stream sink with
write(),end(),abort(),paused, andended.
Tests
npm test
Tests cover stdin/stdout/stderr stream creation, encoding handling, raw mode, and basic write/end lifecycle.
Requirements
Node.js 22 or later. ESM only.