Writable | Documentation

Hierarchy

<internal>.Stream
- Writable

Implements

<internal>.WritableStream

Implemented by

Methods

Static once

once(emitter: <internal>.NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: <internal>.DOMEventTarget, event: string): Promise<any[]>

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

Static on

on(emitter: <internal>.EventEmitter, event: string): <internal>.AsyncIterableIterator<any>

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

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from Stream.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

off

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

Implementation of WritableStream.off
Inherited from Stream.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>.Writable

removeAllListeners

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

Implementation of WritableStream.removeAllListeners
Inherited from Stream.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:735
Parameters
- Optional event: string | symbol
Returns <internal>.Writable

setMaxListeners

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

Implementation of WritableStream.setMaxListeners
Inherited from Stream.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:736
Parameters
- n: number
Returns <internal>.Writable

getMaxListeners

getMaxListeners(): number

Implementation of WritableStream.getMaxListeners
Inherited from Stream.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:737
Returns number

listeners

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

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

rawListeners

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

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

listenerCount

listenerCount(type: string | symbol): number

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

eventNames

eventNames(): (string | symbol)[]

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

pipe

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

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

_write

_write(chunk: any, encoding: string, callback: ((error?: Error) => void)): void

- Defined in node_modules/@types/node/stream.d.ts:131
Parameters
- chunk: any
- encoding: string
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

Optional _writev

_writev(chunks: { chunk: any; encoding: string }[], callback: ((error?: Error) => void)): void

- Defined in node_modules/@types/node/stream.d.ts:132
Parameters
- chunks: { chunk: any; encoding: string }[]
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

_destroy

_destroy(error: Error, callback: ((error?: Error) => void)): void

- Defined in node_modules/@types/node/stream.d.ts:133
Parameters
- error: Error
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

_final

_final(callback: ((error?: Error) => void)): void

- Defined in node_modules/@types/node/stream.d.ts:134
Parameters
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

write

write(chunk: any, cb?: ((error: Error) => void)): boolean
write(chunk: any, encoding: string, cb?: ((error: Error) => void)): boolean

Implementation of WritableStream.write
- Defined in node_modules/@types/node/stream.d.ts:135
Parameters
- chunk: any
- Optional cb: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns boolean
Implementation of WritableStream.write
- Defined in node_modules/@types/node/stream.d.ts:136
Parameters
- chunk: any
- encoding: string
- Optional cb: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns boolean

setDefaultEncoding

setDefaultEncoding(encoding: string): <internal>.Writable

- Defined in node_modules/@types/node/stream.d.ts:137
Parameters
- encoding: string
Returns <internal>.Writable

end

end(cb?: (() => void)): <internal>.Writable
end(chunk: any, cb?: (() => void)): <internal>.Writable
end(chunk: any, encoding: string, cb?: (() => void)): <internal>.Writable

Implementation of WritableStream.end
- Defined in node_modules/@types/node/stream.d.ts:138
Parameters
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of WritableStream.end
- Defined in node_modules/@types/node/stream.d.ts:139
Parameters
- chunk: any
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of WritableStream.end
- Defined in node_modules/@types/node/stream.d.ts:140
Parameters
- chunk: any
- encoding: string
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable

cork

cork(): void

- Defined in node_modules/@types/node/stream.d.ts:141
Returns void

uncork

uncork(): void

- Defined in node_modules/@types/node/stream.d.ts:142
Returns void

destroy

destroy(error?: Error): <internal>.Writable

- Defined in node_modules/@types/node/stream.d.ts:143
Parameters
- Optional error: Error
Returns <internal>.Writable

addListener

addListener(event: "close", listener: (() => void)): <internal>.Writable
addListener(event: "drain", listener: (() => void)): <internal>.Writable
addListener(event: "error", listener: ((err: Error) => void)): <internal>.Writable
addListener(event: "finish", listener: (() => void)): <internal>.Writable
addListener(event: "pipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
addListener(event: "unpipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
addListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Writable

Implementation of WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:155
Event emitter The defined events on documents including:
1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:156
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:157
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:158
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:159
Parameters
- event: "pipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:160
Parameters
- event: "unpipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:161
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Writable

emit

emit(event: "close"): boolean
emit(event: "drain"): boolean
emit(event: "error", err: Error): boolean
emit(event: "finish"): boolean
emit(event: "pipe", src: <internal>.Readable): boolean
emit(event: "unpipe", src: <internal>.Readable): boolean
emit(event: string | symbol, ...args: any[]): boolean

Implementation of WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:163
Parameters
- event: "close"
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:164
Parameters
- event: "drain"
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:165
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:166
Parameters
- event: "finish"
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:167
Parameters
- event: "pipe"
- src: <internal>.Readable
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:168
Parameters
- event: "unpipe"
- src: <internal>.Readable
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:169
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

on

on(event: "close", listener: (() => void)): <internal>.Writable
on(event: "drain", listener: (() => void)): <internal>.Writable
on(event: "error", listener: ((err: Error) => void)): <internal>.Writable
on(event: "finish", listener: (() => void)): <internal>.Writable
on(event: "pipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
on(event: "unpipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
on(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Writable

Implementation of WritableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:171
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:172
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:173
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:174
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:175
Parameters
- event: "pipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:176
Parameters
- event: "unpipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:177
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Writable

once

once(event: "close", listener: (() => void)): <internal>.Writable
once(event: "drain", listener: (() => void)): <internal>.Writable
once(event: "error", listener: ((err: Error) => void)): <internal>.Writable
once(event: "finish", listener: (() => void)): <internal>.Writable
once(event: "pipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
once(event: "unpipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
once(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Writable

Implementation of WritableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:179
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:180
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:181
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:182
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:183
Parameters
- event: "pipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:184
Parameters
- event: "unpipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:185
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Writable

prependListener

prependListener(event: "close", listener: (() => void)): <internal>.Writable
prependListener(event: "drain", listener: (() => void)): <internal>.Writable
prependListener(event: "error", listener: ((err: Error) => void)): <internal>.Writable
prependListener(event: "finish", listener: (() => void)): <internal>.Writable
prependListener(event: "pipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
prependListener(event: "unpipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
prependListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Writable

Implementation of WritableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:187
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:188
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:189
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:190
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:191
Parameters
- event: "pipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:192
Parameters
- event: "unpipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:193
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Writable

prependOnceListener

prependOnceListener(event: "close", listener: (() => void)): <internal>.Writable
prependOnceListener(event: "drain", listener: (() => void)): <internal>.Writable
prependOnceListener(event: "error", listener: ((err: Error) => void)): <internal>.Writable
prependOnceListener(event: "finish", listener: (() => void)): <internal>.Writable
prependOnceListener(event: "pipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
prependOnceListener(event: "unpipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Writable

Implementation of WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:195
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:196
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:197
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:198
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:199
Parameters
- event: "pipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:200
Parameters
- event: "unpipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:201
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Writable

removeListener

removeListener(event: "close", listener: (() => void)): <internal>.Writable
removeListener(event: "drain", listener: (() => void)): <internal>.Writable
removeListener(event: "error", listener: ((err: Error) => void)): <internal>.Writable
removeListener(event: "finish", listener: (() => void)): <internal>.Writable
removeListener(event: "pipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
removeListener(event: "unpipe", listener: ((src: <internal>.Readable) => void)): <internal>.Writable
removeListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Writable

Implementation of WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:203
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:204
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:205
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:206
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:207
Parameters
- event: "pipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:208
Parameters
- event: "unpipe"
- listener: ((src: <internal>.Readable) => void)
  - - (src: <internal>.Readable): void
    - Parameters
      - src: <internal>.Readable
      Returns void
Returns <internal>.Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:209
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Writable

Properties

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.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly writable

writable: boolean

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

destroyed

destroyed: boolean

Constructors

constructor

new Writable(opts?: <internal>.internal.WritableOptions): <internal>.Writable

Overrides Stream.constructor
- Defined in node_modules/@types/node/stream.d.ts:130
Parameters
- Optional opts: <internal>.internal.WritableOptions
Returns <internal>.Writable

Hierarchy

Implements

Implemented by

Index

Methods

Properties

Constructors

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

off

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.Writable

removeAllListeners

Parameters

Optional event: string | symbol

Returns <internal>.Writable

setMaxListeners

Parameters

n: number

Returns <internal>.Writable

getMaxListeners

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

rawListeners

Parameters

event: string | symbol

Returns Function[]

listenerCount

Parameters

type: string | symbol

Returns number

eventNames

Returns (string | symbol)[]

pipe

Type Parameters

T extends <internal>.WritableStream<T>

Parameters

destination: T

Optional options: { end?: boolean }

Optional end?: boolean

Returns T

_write

Parameters

chunk: any

encoding: string

callback: ((error?: Error) => void)

Parameters

Optional error: Error

Returns void

Returns void

Optional _writev

Parameters

chunks: { chunk: any; encoding: string }[]

callback: ((error?: Error) => void)