Http2ServerResponse

Is true after 'close' has been emitted.

See response.socket.

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

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

Boolean value that indicates whether the response has completed. Starts as false. After response.end() executes, the value will be true.

True if headers were sent, false otherwise (read-only).

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

A reference to the original HTTP2 request object.

When true, the Date header will be automatically generated and sent in the response if it is not already present in the headers. Defaults to true.

Returns a Proxy object that acts as a net.Socket (or tls.TLSSocket) but applies getters, setters, and methods based on HTTP/2 logic.

When using implicit headers (not calling response.writeHead() explicitly), this property controls the status code that will be sent to the client when the headers get flushed.

Status message is not supported by HTTP/2 (RFC 7540 8.1.2.4). It returns an empty string.

The Http2Stream object backing the response.

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).

Event emitter The defined events on documents including:

This method adds HTTP trailing headers (a header but at the end of the message) to the response.

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.

Call http2stream.pushStream() with the given headers, and wrap the given Http2Stream on a newly created Http2ServerResponse as the callback parameter if successful. When Http2ServerRequest is closed, the callback is called with an error ERR_HTTP2_INVALID_STREAM.

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.

This method signals to the server that all of the response headers and body have been sent; that server should consider this message complete. The method, response.end(), MUST be called on each response.

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

Reads out a header that has already been queued but not sent to the client. The name is case-insensitive.

Returns an array containing the unique names of the current outgoing headers. All header 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 matching is case-insensitive.

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 a header that has been queued for implicit sending.

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.

Sets a single header value for implicit headers. If this header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings here 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.

Sets the Http2Stream's timeout value to msecs. If a callback is provided, then it is added as a listener on the 'timeout' event on the response object.

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

If this method is called and response.writeHead() has not been called, it will switch to implicit header mode and flush the implicit headers.

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.

Sends a status 100 Continue to the client, indicating that the request body should be sent. See the 'checkContinue' event on Http2Server and Http2SecureServer.

Sends a status 103 Early Hints to the client with a Link header, indicating that the user agent can preload/preconnect the linked resources. The hints is an object containing the values of headers to be sent with early hints message.

Sends a response header to the request. The status code is a 3-digit HTTP status code, like 404. The last argument, headers, are the response headers.