Skip to main content
Module

x/readable_stream/mod.ts>Readable

Node-core streams for userland
ahuggins-nhs/readable-stream
Latest
interface Readable
Re-export
import { type Readable } from "https://deno.land/x/readable_stream@v3.6.0-deno.0.3.0/mod.ts";

Properties

ReadableState: ReadableState
_readableState: ReadableState
readable: boolean
readableEncoding: BufferEncoding | null
readableEnded: boolean
readableFlowing: boolean | null
readableHighWaterMark: number
readableLength: number
readableObjectMode: boolean
destroyed: boolean

Methods

new(options?: ReadableOptions): Readable
_fromList(n: any, state: any): any
_read(size: number): void
read(size?: number): any
setEncoding(encoding: BufferEncoding): this
pause(): this
resume(): this
isPaused(): boolean
unpipe(destination?: WritableStream): this
unshift(chunk: any, encoding?: BufferEncoding): void
wrap(oldStream: ReadableStream): this
push(chunk: any, encoding?: BufferEncoding): boolean
_destroy(error: Error | null, callback: (error?: Error | null) => void): void
destroy(error?: Error): void
from(iterable: any, opts: any): never
addListener(event: "close", listener: () => void): this

Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. error
  5. pause
  6. readable
  7. resume
addListener(event: "data", listener: (chunk: any) => void): this
addListener(event: "end", listener: () => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: "pause", listener: () => void): this
addListener(event: "readable", listener: () => void): this
addListener(event: "resume", listener: () => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this
emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "error", err: Error): boolean
emit(event: "pause"): boolean
emit(event: "readable"): boolean
emit(event: "resume"): boolean
emit(event: string | symbol, ...args: any[]): boolean
on(event: "close", listener: () => void): this
on(event: "data", listener: (chunk: any) => void): this
on(event: "end", listener: () => void): this
on(event: "error", listener: (err: Error) => void): this
on(event: "pause", listener: () => void): this
on(event: "readable", listener: () => void): this
on(event: "resume", listener: () => void): this
on(event: string | symbol, listener: (...args: any[]) => void): this
once(event: "close", listener: () => void): this
once(event: "data", listener: (chunk: any) => void): this
once(event: "end", listener: () => void): this
once(event: "error", listener: (err: Error) => void): this
once(event: "pause", listener: () => void): this
once(event: "readable", listener: () => void): this
once(event: "resume", listener: () => void): this
once(event: string | symbol, listener: (...args: any[]) => void): this
prependListener(event: "close", listener: () => void): this
prependListener(event: "data", listener: (chunk: any) => void): this
prependListener(event: "end", listener: () => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: "pause", listener: () => void): this
prependListener(event: "readable", listener: () => void): this
prependListener(event: "resume", listener: () => void): this
prependListener(event: string | symbol, listener: (...args: any[]) => void): this
prependOnceListener(event: "close", listener: () => void): this
prependOnceListener(event: "data", listener: (chunk: any) => void): this
prependOnceListener(event: "end", listener: () => void): this
prependOnceListener(event: "error", listener: (err: Error) => void): this
prependOnceListener(event: "pause", listener: () => void): this
prependOnceListener(event: "readable", listener: () => void): this
prependOnceListener(event: "resume", listener: () => void): this
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this
removeListener(event: "close", listener: () => void): this
removeListener(event: "data", listener: (chunk: any) => void): this
removeListener(event: "end", listener: () => void): this
removeListener(event: "error", listener: (err: Error) => void): this
removeListener(event: "pause", listener: () => void): this
removeListener(event: "readable", listener: () => void): this
removeListener(event: "resume", listener: () => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this
[[Symbol.asyncIterator]](): AsyncIterableIterator<any>
variable Readable
Re-export
import { Readable } from "https://deno.land/x/readable_stream@v3.6.0-deno.0.3.0/mod.ts";