Interface ReadableStream

Hierarchy

<internal>.EventEmitter
- ReadableStream
  - <internal>.ReadWriteStream

Implemented by

Methods

addListener

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

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

on

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

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

once

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

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

removeListener

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

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

off

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): <internal>.ReadableStream

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

setMaxListeners

setMaxListeners(n: number): <internal>.ReadableStream

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

getMaxListeners

getMaxListeners(): number

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

listeners

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

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

rawListeners

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

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

emit

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

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

listenerCount

listenerCount(type: string | symbol): number

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

prependListener

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

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

prependOnceListener

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

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

eventNames

eventNames(): (string | symbol)[]

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

read

read(size?: number): string | <internal>.Buffer

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

setEncoding

setEncoding(encoding: string): <internal>.ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:751
Parameters
- encoding: string
Returns <internal>.ReadableStream

pause

pause(): <internal>.ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:752
Returns <internal>.ReadableStream

resume

resume(): <internal>.ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:753
Returns <internal>.ReadableStream

isPaused

isPaused(): boolean

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

pipe

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

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

unpipe

unpipe(destination?: <internal>.WritableStream): <internal>.ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:756
Parameters
- Optional destination: <internal>.WritableStream
Returns <internal>.ReadableStream

unshift

unshift(chunk: string | Uint8Array, encoding?: <internal>.BufferEncoding): void

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

wrap

wrap(oldStream: <internal>.ReadableStream): <internal>.ReadableStream

- Defined in node_modules/@types/node/globals.d.ts:758
Parameters
- oldStream: <internal>.ReadableStream
Returns <internal>.ReadableStream

[asyncIterator]

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

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

Properties

readable

readable: boolean

Generated using TypeDoc