Class Writable

Hierarchy

Stream
- Writable

Implements

WritableStream

Implemented by

Duplex

Constructors

constructor

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

Properties

destroyed

destroyed: boolean

`Readonly` writable

writable: boolean

`Readonly` writableCorked

writableCorked: number

`Readonly` writableEnded

writableEnded: boolean

`Readonly` writableFinished

writableFinished: boolean

`Readonly` writableHighWaterMark

writableHighWaterMark: number

`Readonly` writableLength

writableLength: number

`Readonly` writableObjectMode

writableObjectMode: boolean

`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

_destroy

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

_final

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

_write

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

`Optional` _writev

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

addListener

addListener(event, listener): Writable
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 Writable
Implementation of WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:174
addListener(event, listener): Writable
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:175
addListener(event, listener): Writable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:176
addListener(event, listener): Writable
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:177
addListener(event, listener): Writable
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:178
addListener(event, listener): Writable
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:179
addListener(event, listener): Writable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:180

cork

cork(): void
Returns void
- Defined in node_modules/@types/node/stream.d.ts:160

destroy

destroy(error?): void
Parameters
- Optional error: Error
Returns void
- Defined in node_modules/@types/node/stream.d.ts:162

emit

emit(event): boolean
Parameters
- event: "close"
Returns boolean
Implementation of WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:182
emit(event): boolean
Parameters
- event: "drain"
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:183
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:184
emit(event): boolean
Parameters
- event: "finish"
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:185
emit(event, src): boolean
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:186
emit(event, src): boolean
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:187
emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:188

end

end(cb?): void
Parameters
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of WritableStream.end
- Defined in node_modules/@types/node/stream.d.ts:157
end(chunk, cb?): void
Parameters
- chunk: any
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of WritableStream.end
- Defined in node_modules/@types/node/stream.d.ts:158
end(chunk, encoding, cb?): void
Parameters
- chunk: any
- encoding: string
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of WritableStream.end
- Defined in node_modules/@types/node/stream.d.ts:159

eventNames

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

getMaxListeners

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

listenerCount

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

listeners

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

off

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

on

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

once

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

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 Stream.pipe
- Defined in node_modules/@types/node/stream.d.ts:5

prependListener

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

prependOnceListener

prependOnceListener(event, listener): Writable
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:214
prependOnceListener(event, listener): Writable
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:215
prependOnceListener(event, listener): Writable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:216
prependOnceListener(event, listener): Writable
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:217
prependOnceListener(event, listener): Writable
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:218
prependOnceListener(event, listener): Writable
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:219
prependOnceListener(event, listener): Writable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:220

rawListeners

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

removeAllListeners

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

removeListener

removeListener(event, listener): Writable
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:222
removeListener(event, listener): Writable
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:223
removeListener(event, listener): Writable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:224
removeListener(event, listener): Writable
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:225
removeListener(event, listener): Writable
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:226
removeListener(event, listener): Writable
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:227
removeListener(event, listener): Writable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Writable
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:228

setDefaultEncoding

setDefaultEncoding(encoding): Writable
Parameters
- encoding: string
Returns Writable
- Defined in node_modules/@types/node/stream.d.ts:156

setMaxListeners

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

uncork

uncork(): void
Returns void
- Defined in node_modules/@types/node/stream.d.ts:161

write

write(chunk, cb?): boolean
Parameters
- chunk: any
- Optional cb: ((error) => void)
  - - (error): void
    - Parameters
      error: undefined | null | Error
      Returns void
Returns boolean
Implementation of WritableStream.write
- Defined in node_modules/@types/node/stream.d.ts:154
write(chunk, encoding, cb?): boolean
Parameters
- chunk: any
- encoding: string
- Optional cb: ((error) => void)
  - - (error): void
    - Parameters
      error: undefined | null | Error
      Returns void
Returns boolean
Implementation of WritableStream.write
- Defined in node_modules/@types/node/stream.d.ts:155

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Deprecated
since v4.0.0
Inherited from Stream.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 Stream.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 Stream.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 Stream.once
- Defined in node_modules/@types/node/events.d.ts:22

Class Writable

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: WritableOptions

Returns Writable

Properties

destroyed

Readonly writable

Readonly writableCorked

Readonly writableEnded

Readonly writableFinished

Readonly writableHighWaterMark

Readonly writableLength

Readonly writableObjectMode

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

_destroy

Parameters

error: null | Error

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

_final

Parameters

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

_write

Parameters

chunk: any

encoding: string

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

Optional _writev

Parameters

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

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

addListener

Parameters

event: "close"

listener: (() => void)

Returns void

Returns Writable

Parameters

event: "drain"

listener: (() => void)

Returns void

Returns Writable

Parameters

event: "error"

listener: ((err) => void)

Parameters

err: Error

Returns void

Returns Writable

Parameters

event: "finish"

listener: (() => void)

`Optional` opts: WritableOptions

`Readonly` writable

`Readonly` writableCorked

`Readonly` writableEnded

`Readonly` writableFinished

`Readonly` writableHighWaterMark

`Readonly` writableLength

`Readonly` writableObjectMode

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Optional` error: null | Error

`Optional` error: null | Error

`Optional` error: null | Error

`Optional` _writev

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

`Optional` error: null | Error

`Rest` ...args: any[]

`Optional` error: Error

`Rest` ...args: any[]

`Optional` cb: (() => void)

`Optional` cb: (() => void)

`Optional` cb: (() => void)