OutgoingMessage

Is true after 'close' has been emitted.

Alias of outgoingMessage.socket.

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

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

Read-only. true if the headers were sent, otherwise false.

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

Reference to the underlying socket. Usually, users will not want to access this property.

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.

Event emitter The defined events on documents including:

Adds HTTP trailers (headers but at the end of the message) to the message.

Append a single header value to the header object.

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.

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.

Flushes the message headers.

Gets the value of the HTTP header with the given name. If that header is not set, the returned value will be undefined.

Returns an array containing the unique names of the current outgoing headers. All names are lowercase.

Returns a shallow copy of the current outgoing headers. Since a shallow copy is used, array values may be mutated without additional calls to various header-related HTTP module methods. The keys of the returned object are the header names and the values are the respective header values. All header names are lowercase.

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

Returns true if the header identified by name is currently set in the outgoing headers. The header name is case-insensitive.

Removes a header that is queued for implicit sending.

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

Sets a single header value. If the header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings to send multiple headers with the same name.

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.

Once a socket is associated with the message and is connected, socket.setTimeout() will be called with msecs as the first parameter.

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.