Class Stream

Hierarchy

internal
- Stream
  - Readable
  - Writable

Constructors

constructor

new Stream(opts?): Stream
Parameters
- Optional opts: ReadableOptions
Returns Stream
Overrides internal.constructor
- Defined in node_modules/@types/node/stream.d.ts:10

Properties

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

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

emit

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

eventNames

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

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from internal.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:576

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Inherited from internal.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:580

listeners

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

off

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

on

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

once

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

pipe

pipe<T>(destination, options?): T
Type Parameters
- T extends WritableStream
Parameters
- destination: T
- Optional options: {
  end?: boolean;
  }
  - Optional end?: boolean
Returns T
Inherited from internal.pipe
- Defined in node_modules/@types/node/stream.d.ts:5

prependListener

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

prependOnceListener

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

rawListeners

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

removeAllListeners

removeAllListeners(event?): Stream
Parameters
- Optional event: string | symbol
Returns Stream
Inherited from internal.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:574

removeListener

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

setMaxListeners

setMaxListeners(n): Stream
Parameters
- n: number
Returns Stream
Inherited from internal.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:575

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Deprecated
since v4.0.0
Inherited from internal.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter, event): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from internal.on
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter, event): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from internal.once
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter, event): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from internal.once
- Defined in node_modules/@types/node/events.d.ts:22

Class Stream

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: ReadableOptions

Returns Stream

Properties

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Stream

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Stream

on

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Stream

once

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Stream

pipe

Type Parameters

T extends WritableStream

Parameters

destination: T

Optional options: { end?: boolean; }

Optional end?: boolean

Returns T

prependListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

`Optional` opts: ReadableOptions

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` options: {
end?: boolean;
}

`Optional` end?: boolean

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol

`Rest` ...args: any[]

`Static` listenerCount

`Static` on

`Static` once