Class Writable

Hierarchy (view full)

Stream
- Writable

Implements

WritableStream

Implemented by

Duplex

Constructors

constructor

new Writable(opts?): internal.Writable
Parameters
- Optional opts: internal.WritableOptions
Returns internal.Writable
Overrides Stream.constructor

Properties

writable

writable: boolean

`Readonly` writableHighWaterMark

writableHighWaterMark: number

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

_destroy(error, callback): void
Parameters
- error: null | Error
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: Error
      Returns void
Returns void

_final

_final(callback): void
Parameters
- callback: Function
Returns void

_write

_write(chunk, encoding, callback): void
Parameters
- chunk: any
- encoding: string
- callback: ((err?) => void)
  - - (err?): void
    - Parameters
      Optional err: Error
      Returns void
Returns void

`Optional` _writev

_writev(chunks, callback): void
Parameters
- chunks: {
  chunk: any;
  encoding: string;
  }[]
- callback: ((err?) => void)
  - - (err?): void
    - Parameters
      Optional err: Error
      Returns void
Returns void

addListener

addListener(event, listener): this
Event emitter The defined events on documents including:
1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of WritableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener
addListener(event, listener): this
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.addListener
Overrides Stream.addListener

cork

cork(): void
Returns void

destroy

destroy(error?): void
Parameters
- Optional error: Error
Returns void

emit

emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Implementation of WritableStream.emit
Overrides Stream.emit
emit(event): boolean
Parameters
- event: "close"
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
emit(event, chunk): boolean
Parameters
- event: "drain"
- chunk: string | Buffer
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
emit(event): boolean
Parameters
- event: "finish"
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
emit(event, src): boolean
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit
emit(event, src): boolean
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Implementation of NodeJS.WritableStream.emit
Overrides Stream.emit

end

end(cb?): void
Parameters
- Optional cb: Function
Returns void
Implementation of WritableStream.end
end(chunk, cb?): void
Parameters
- chunk: any
- Optional cb: Function
Returns void
Implementation of WritableStream.end
end(chunk, encoding?, cb?): void
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: Function
Returns void
Implementation of WritableStream.end

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Implementation of WritableStream.eventNames
Inherited from Stream.eventNames

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of WritableStream.getMaxListeners
Inherited from Stream.getMaxListeners

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Implementation of WritableStream.listenerCount
Inherited from Stream.listenerCount

listeners

listeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of WritableStream.listeners
Inherited from Stream.listeners

on

on(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of WritableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.on
Overrides Stream.on
on(event, listener): this
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.on
Overrides Stream.on

once

once(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of WritableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.once
Overrides Stream.once
once(event, listener): this
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.once
Overrides Stream.once

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

prependListener

prependListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of WritableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener
prependListener(event, listener): this
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.prependListener
Overrides Stream.prependListener

prependOnceListener

prependOnceListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.prependOnceListener
Overrides Stream.prependOnceListener

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: string | symbol
Returns this
Implementation of WritableStream.removeAllListeners
Inherited from Stream.removeAllListeners

removeListener

removeListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of WritableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "finish"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "pipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener
removeListener(event, listener): this
Parameters
- event: "unpipe"
- listener: ((src) => void)
  - - (src): void
    - Parameters
      src: Readable
      Returns void
Returns this
Implementation of NodeJS.WritableStream.removeListener
Overrides Stream.removeListener

setDefaultEncoding

setDefaultEncoding(encoding): this
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Implementation of WritableStream.setMaxListeners
Inherited from Stream.setMaxListeners

uncork

uncork(): void
Returns void

write

write(chunk, cb?): boolean
Parameters
- chunk: any
- Optional cb: Function
Returns boolean
Implementation of WritableStream.write
write(chunk, encoding?, cb?): boolean
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: Function
Returns boolean
Implementation of WritableStream.write

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from Stream.listenerCount

Class Writable

Hierarchy (view full)

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: internal.WritableOptions

Returns internal.Writable

Properties

writable

Readonly writableHighWaterMark

Static defaultMaxListeners

Methods

_destroy

Parameters

error: null | Error

callback: ((error?) => void)

Parameters

Optional error: Error

Returns void

Returns void

_final

Parameters

callback: Function

Returns void

_write

Parameters

chunk: any

encoding: string

callback: ((err?) => void)

Parameters

Optional err: Error

Returns void

Returns void

Optional _writev

Parameters

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

callback: ((err?) => void)

Parameters

Optional err: Error

Returns void

Returns void

addListener

Parameters

event: string

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

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: (() => void)

Returns void

Returns this

Parameters

event: "drain"

listener: (() => void)

Returns void

Returns this

Parameters

event: "error"

listener: ((err) => void)

Parameters

err: Error

Returns void

Returns this

Parameters

event: "finish"

listener: (() => void)

Returns void

Returns this

Parameters

event: "pipe"

listener: ((src) => void)

`Optional` opts: internal.WritableOptions

`Readonly` writableHighWaterMark

`Static` defaultMaxListeners

`Optional` error: Error

`Optional` err: Error

`Optional` _writev

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

`Optional` err: Error

`Rest` ...args: any[]

`Optional` error: Error

`Rest` ...args: any[]

`Optional` cb: Function

`Optional` cb: Function

`Optional` encoding: string

`Optional` cb: Function