Skip to main content
ReadableBase.prototype.destroy - stream - Node documentation
method ReadableBase.prototype.destroy

Usage in Deno

import { ReadableBase } from "node:stream";
ReadableBase.prototype.destroy(error?: Error): this

Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.

Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

Implementors should not override this method, but instead implement readable._destroy().

Parameters

optional
error: Error

Error which will be passed as payload in 'error' event

Return Type

this