Skip to main content
Http2ServerResponse.prototype.write - http2 - Node documentation
method Http2ServerResponse.prototype.write

Usage in Deno

import { Http2ServerResponse } from "node:http2";
Http2ServerResponse.prototype.write(
chunk: string | Uint8Array,
callback?: (err: Error) => void,
): boolean

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

This sends a chunk of the response body. This method may be called multiple times to provide successive parts of the body.

In the node:http module, the response body is omitted when the request is a HEAD request. Similarly, the 204 and 304 responses must not include a message body.

chunk can be a string or a buffer. If chunk is a string, the second parameter specifies how to encode it into a byte stream. By default the encoding is 'utf8'. callback will be called when this chunk of data is flushed.

This is the raw HTTP body and has nothing to do with higher-level multi-part body encodings that may be used.

The first time response.write() is called, it will send the buffered header information and the first chunk of the body to the client. The second time response.write() is called, Node.js assumes data will be streamed, and sends the new data separately. That is, the response is buffered up to the first chunk of the body.

Returns true if the entire data was flushed successfully to the kernel buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is free again.

Parameters

chunk: string | Uint8Array
optional
callback: (err: Error) => void

Return Type

boolean
Http2ServerResponse.prototype.write(
chunk: string | Uint8Array,
encoding: BufferEncoding,
callback?: (err: Error) => void,
): boolean

Parameters

chunk: string | Uint8Array
encoding: BufferEncoding
optional
callback: (err: Error) => void

Return Type

boolean
Back to top