Interface ReadableStream

Hierarchy

EventEmitter
- ReadableStream
  - ReadWriteStream

Index

Properties

readable

Properties

readable

readable: boolean

Methods

[Symbol.asyncIterator]

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

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

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ReadableStream

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/globals.d.ts:547
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ReadableStream

emit

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

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

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/globals.d.ts:562
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

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

isPaused

isPaused(): boolean

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- type: string | symbol
Returns number

listeners

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

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

off

off(event: string | symbol, listener: (...args: any[]) => void): ReadableStream

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/globals.d.ts:551
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ReadableStream

on

on(event: string | symbol, listener: (...args: any[]) => void): ReadableStream

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/globals.d.ts:548
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ReadableStream

once

once(event: string | symbol, listener: (...args: any[]) => void): ReadableStream

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/globals.d.ts:549
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ReadableStream

pause

pause(): ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:569
Returns ReadableStream

pipe

pipe<T>(destination: T, options?: { end?: undefined | boolean }): T

- Defined in node_modules/@types/node/globals.d.ts:572
Type parameters
- T: WritableStream<T>
Parameters
- destination: T
- Optional options: { end?: undefined | boolean }
  - Optional end?: undefined | boolean
Returns T

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ReadableStream

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/globals.d.ts:560
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ReadableStream

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ReadableStream

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/globals.d.ts:561
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ReadableStream

rawListeners

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

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

read

read(size?: number): string | Buffer

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

removeAllListeners

removeAllListeners(event?: string | symbol): ReadableStream

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns ReadableStream

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ReadableStream

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/globals.d.ts:550
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ReadableStream

resume

resume(): ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:570
Returns ReadableStream

setEncoding

setEncoding(encoding: string): ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:568
Parameters
- encoding: string
Returns ReadableStream

setMaxListeners

setMaxListeners(n: number): ReadableStream

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns ReadableStream

unpipe

unpipe(destination?: WritableStream): ReadableStream

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

unshift

unshift(chunk: string | Uint8Array, encoding?: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"): void

- Defined in node_modules/@types/node/globals.d.ts:574
Parameters
- chunk: string | Uint8Array
- Optional encoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"
Returns void

wrap

wrap(oldStream: ReadableStream): ReadableStream

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

Generated using TypeDoc