WriteStream

The number of bytes written so far. Does not include data that is still queued for writing.

Is true after 'close' has been emitted.

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

Returns error if the stream has been destroyed with an error.

The path to the file the stream is writing to as specified in the first argument to {@link createWriteStream}. If path is passed as a string, thenwriteStream.path will be a string. If path is passed as a Buffer, thenwriteStream.path will be a Buffer.

This property is true if the underlying file has not been opened yet, i.e. before the 'ready' event is emitted.

Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

Number of times writable.uncork() needs to be called in order to fully uncork the stream.

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.

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

Return the value of highWaterMark passed when creating this Writable.

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.

Is true if the stream's buffer has been full and stream will emit 'drain'.

Getter for the property objectMode of a given Writable stream.

Alias for emitter.on(eventName, listener).

events.EventEmitter

Closes writeStream. Optionally accepts a callback that will be executed once the writeStreamis closed.

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

Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to 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.

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

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.

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Returns a copy of the array of listeners for the event named eventName.

Alias for emitter.removeListener().

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

Removes all listeners, or those of the specified eventName.

Removes the specified listener from the listener array for the event named eventName.

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

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

The writable.uncork() method flushes all data buffered since {@link cork} was called.

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 will be called with the error as its first argument. The callback is called asynchronously and before 'error' is emitted.