API · Low level

pause()

Stop this branch from accepting more delivery and propagate pressure upstream.

Signature

pause(fromInside?: boolean): this

Parameters

fromInside defaults to false and is an internal coordination flag. User code should omit it. External and internal pause reasons are tracked independently; both must be cleared before delivery resumes.

Behavior

Pause is immediate, idempotent, and propagates to the source. Manual writes accepted while paused enter this stream’s configured buffer and return false; overflow follows bufferLimit and overflow. Existing buffered values remain until resume, graceful end, or destructive termination.

Use pause/resume only for adapter-level integration. Normal operators, pipeTo(), async consumers, and terminals already coordinate backpressure automatically.

Related

resume(), write(), consume()