Skip to main content

NodeOutgoingMessage

NodeOutgoingMessage is the low-level outgoing response interface. It combines Node.js Writable with the core fields of http.ServerResponse. HttpOutgoing extends this interface with higher-level helpers.

import { NodeOutgoingMessage } from '@opra/http';

Properties

These properties and methods are picked from Node.js http.ServerResponse:

PropertyTypeDescription
reqNodeIncomingMessageThe paired incoming request.
statusCodenumberHTTP status code.
statusMessagestringHTTP status message.
headersSentbooleantrue after headers have been flushed.
sendDatebooleanWhether to automatically send the Date header.

Methods

MethodDescription
setHeader(name, value)Set a response header.
appendHeader(name, value)Append to an existing header value.
getHeader(name)Get a header value.
getHeaders()Get all headers as an object.
getHeaderNames()Get all header names.
getRawHeaderNames()Get raw header names.
hasHeader(name)Check if a header is set.
removeHeader(name)Remove a header.
addTrailers(headers)Add trailing headers.
flushHeaders()Flush the response headers immediately.

Namespace

NodeOutgoingMessage.from(init)

NodeOutgoingMessage.from(init: Initiator): NodeOutgoingMessage

Creates a NodeOutgoingMessage from an Initiator object.


Interfaces

NodeOutgoingMessage.Initiator

Used with NodeOutgoingMessage.from() to construct a response from a plain object.

PropertyTypeDescription
reqNodeIncomingMessageThe paired incoming request (required).
statusCodenumber | undefinedHTTP status code.
statusMessagestring | undefinedHTTP status message.
headersOutgoingHttpHeaders | Headers | Map<string, any> | string[] | undefinedResponse headers.
chunkedEncodingboolean | undefinedWhether to use chunked transfer encoding.
sendDateboolean | undefinedWhether to send the Date header automatically.
strictContentLengthboolean | undefinedEnforce strict content-length validation.
bodystring | Iterable<any> | AsyncIterable<any> | Object | undefinedResponse body.
parsedUrlURL | undefinedPre-parsed URL for the request.