Class Readable

Hierarchy (view full)

Stream
- Readable
  - IncomingMessage
  - Duplex

Implements

ReadableStream

Constructors

constructor

new Readable(opts?): Readable
Parameters
- Optional opts: ReadableOptions
Returns Readable
Overrides Stream.constructor

Properties

readable

readable: boolean

`Readonly` readableHighWaterMark

readableHighWaterMark: number

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

_destroy(error, callback): void
Parameters
- error: null | Error
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: Error
      Returns void
Returns void

_read

_read(size): void
Parameters
- size: number
Returns void

addListener

addListener(event, listener): this
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of ReadableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener

destroy

destroy(error?): void
Parameters
- Optional error: Error
Returns void

emit

emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Implementation of ReadableStream.emit
Overrides Stream.emit
emit(event): boolean
Parameters
- event: "close"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
emit(event, chunk): boolean
Parameters
- event: "data"
- chunk: string | Buffer
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
emit(event): boolean
Parameters
- event: "end"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
emit(event): boolean
Parameters
- event: "readable"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Implementation of ReadableStream.eventNames
Inherited from Stream.eventNames

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of ReadableStream.getMaxListeners
Inherited from Stream.getMaxListeners

isPaused

isPaused(): boolean
Returns boolean
Implementation of ReadableStream.isPaused

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Implementation of ReadableStream.listenerCount
Inherited from Stream.listenerCount

listeners

listeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of ReadableStream.listeners
Inherited from Stream.listeners

on

on(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of ReadableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on

once

once(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of ReadableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once

pause

pause(): this
Returns this
Implementation of ReadableStream.pause

pipe

pipe<T>(destination, options?): T
Type Parameters
- T extends WritableStream
Parameters
- destination: T
- Optional options: {
  end?: boolean;
  }
  - Optional end?: boolean
Returns T
Implementation of ReadableStream.pipe
Inherited from Stream.pipe

prependListener

prependListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of ReadableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener

prependOnceListener

prependOnceListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener

push

push(chunk, encoding?): boolean
Parameters
- chunk: any
- Optional encoding: string
Returns boolean

read

read(size?): any
Parameters
- Optional size: number
Returns any
Implementation of ReadableStream.read

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: string | symbol
Returns this
Implementation of ReadableStream.removeAllListeners
Inherited from Stream.removeAllListeners

removeListener

removeListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of ReadableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener

resume

resume(): this
Returns this
Implementation of ReadableStream.resume

setEncoding

setEncoding(encoding): this
Parameters
- encoding: string
Returns this
Implementation of ReadableStream.setEncoding

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Implementation of ReadableStream.setMaxListeners
Inherited from Stream.setMaxListeners

unpipe

unpipe<T>(destination?): this
Type Parameters
- T extends WritableStream
Parameters
- Optional destination: T
Returns this
Implementation of ReadableStream.unpipe

unshift

unshift(chunk): void
Parameters
- chunk: any
Returns void
Implementation of ReadableStream.unshift

wrap

wrap(oldStream): this
Parameters
- oldStream: ReadableStream
Returns this
Implementation of ReadableStream.wrap

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from Stream.listenerCount

Class Readable

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: ReadableOptions

Returns Readable

Properties

readable

Readonly readableHighWaterMark

Static defaultMaxListeners

Methods

_destroy

Parameters

error: null | Error

callback: ((error?) => void)

Parameters

Optional error: Error

Returns void

Returns void

_read

Parameters

size: number

Returns void

addListener

Parameters

event: string

listener: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: (() => void)

Returns void

Returns this

Parameters

event: "data"

listener: ((chunk) => void)

Parameters

chunk: string | Buffer

Returns void

Returns this

Parameters

event: "end"

listener: (() => void)

Returns void

Returns this

Parameters

event: "readable"

listener: (() => void)

Returns void

Returns this

Parameters

event: "error"

listener: ((err) => void)

Parameters

err: Error

Returns void

Returns this

destroy

Parameters

Optional error: Error

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "close"

Returns boolean

Parameters

event: "data"

`Optional` opts: ReadableOptions

`Readonly` readableHighWaterMark

`Static` defaultMaxListeners

`Optional` error: Error

`Rest` ...args: any[]

`Optional` error: Error

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]