Interface ReadableStream

Hierarchy

EventEmitter
- ReadableStream
  - ReadWriteStream

Implemented by

Index

Properties

readable

Properties

readable

readable: boolean

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterableIterator<string | Buffer>

- Defined in node_modules/@types/node/globals.d.ts:454
Returns AsyncIterableIterator<string | Buffer>

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

isPaused

isPaused(): boolean

- Defined in node_modules/@types/node/globals.d.ts:449
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pause

pause(): this

- Defined in node_modules/@types/node/globals.d.ts:447
Returns this

pipe

pipe<T>(destination: T, options?: object): T

- Defined in node_modules/@types/node/globals.d.ts:450
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: object
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: number): string | Buffer

- Defined in node_modules/@types/node/globals.d.ts:445
Parameters
- Optional size: number
Returns string | Buffer

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resume

resume(): this

- Defined in node_modules/@types/node/globals.d.ts:448
Returns this

setEncoding

setEncoding(encoding: BufferEncoding): this

- Defined in node_modules/@types/node/globals.d.ts:446
Parameters
- encoding: BufferEncoding
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

unpipe

unpipe(destination?: WritableStream): this

- Defined in node_modules/@types/node/globals.d.ts:451
Parameters
- Optional destination: WritableStream
Returns this

unshift

unshift(chunk: string | Uint8Array, encoding?: BufferEncoding): void

- Defined in node_modules/@types/node/globals.d.ts:452
Parameters
- chunk: string | Uint8Array
- Optional encoding: BufferEncoding
Returns void

wrap

wrap(oldStream: ReadableStream): this

- Defined in node_modules/@types/node/globals.d.ts:453
Parameters
- oldStream: ReadableStream
Returns this

Generated using TypeDoc