Writable

View source
js.node.events.EventEmitter → js.node.Stream → js.node.stream.Writable (extern class) → js.node.fs.WriteStream

The Writable stream interface is an abstraction for a destination that you are writing data to.

Examples of writable streams include:

  • http requests, on the client
  • http responses, on the server
  • fs write streams
  • zlib streams
  • crypto streams
  • tcp sockets
  • child process stdin
  • process.stdout, process.stderr

Instance Members

destroyed: Bool

Is true after writable.destroy() has been called.

See: https://nodejs.org/api/stream.html#stream_writable_destroyed
writable: Bool

Is true if it is safe to call writable.write().

See: https://nodejs.org/api/stream.html#stream_writable_writable
writableEnded: Bool

Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

See: https://nodejs.org/api/stream.html#stream_writable_writableended
writableFinished: Bool

Is set to true immediately before the 'finish' event is emitted.

See: https://nodejs.org/api/stream.html#stream_writable_writablefinished
writablehighWaterMark: Int

Return the value of highWaterMark passed when constructing this Writable.

See: https://nodejs.org/api/stream.html#stream_writable_writablehighwatermark
writableLength: Int

This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

See: https://nodejs.org/api/stream.html#stream_writable_writablelength
writableObjectMode: Bool

Getter for the property objectMode of a given Writable stream.

See: https://nodejs.org/api/stream.html#stream_writable_writableobjectmode
isTTY: Bool

Terminal write streams (i.e. process.stdout) have this property set to true. It is false for any other write streams.

See: https://nodejs.org/api/tty.html#tty_writestream_istty
cork(): Void

The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the stream.uncork() or stream.end() methods are called.

See: https://nodejs.org/api/stream.html#stream_writable_cork

Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event unless emitClose is set in false. After this call, the writable stream has ended and subsequent calls to write() or end() will result in an ERR_STREAM_DESTROYED error. This is a destructive and immediate way to destroy a stream. Previous calls to write() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. Use end() instead of destroy if data should flush before close, or wait for the 'drain' event before destroying the stream. Implementors should not override this method, but instead implement writable._destroy().

See: https://nodejs.org/api/stream.html#stream_writable_destroy_error
Name Type Default
error js.lib.Error (optional)
Returns
js.node.stream.Writable.TSelf
end(chunk: Dynamic, ?encoding: String, ?callback: haxe.extern.EitherType<Function, Function>): Void

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream. If provided, the optional callback function is attached as a listener for the 'finish' event.

See: https://nodejs.org/api/stream.html#stream_writable_end_chunk_encoding_callback
Name Type Default
chunk Dynamic
encoding String (optional)
callback haxe.extern.EitherType<Function, Function> (optional)
setDefaultEncoding(encoding: String): js.node.stream.Writable.TSelf

The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

See: https://nodejs.org/api/stream.html#stream_writable_setdefaultencoding_encoding
Name Type
encoding String
Returns
js.node.stream.Writable.TSelf
uncork(): Void

The writable.uncork() method flushes all data buffered since stream.cork() was called.

See: https://nodejs.org/api/stream.html#stream_writable_uncork
write(chunk: Dynamic, ?encoding: String, ?callback: haxe.extern.EitherType<Function, Function>): Bool

The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback may or may not be called with the error as its first argument. To reliably detect write errors, add a listener for the 'error' event.

See: https://nodejs.org/api/stream.html#stream_writable_write_chunk_encoding_callback
Name Type Default
chunk Dynamic
encoding String (optional)
callback haxe.extern.EitherType<Function, Function> (optional)
Returns
Bool
See: https://nodejs.org/api/stream.html#stream_constructor_new_stream_writable_options
Name Type Default
options WritableNewOptionsAdapter (optional)

Metadata

Name Parameters
:jsRequire "stream", "Writable"