Package-level declarations

Types

open external class Agent : EventEmitter

An Agent is responsible for managing connection persistence and reuse for HTTP clients. It maintains a queue of pending requests for a given host and port, reusing a single socket connection for each until the queue is empty, at which time the socket is either destroyed or put into a pool where it is kept to be used again for requests to the same host and port. Whether it is destroyed or pooled depends on the keepAlive option.

AgentOptions

external interface AgentOptions : TcpSocketConnectOpts

AgentOptionsScheduling

sealed external interface AgentOptionsScheduling

ClientRequest

external class ClientRequest : OutgoingMessage<IncomingMessage>

This object is created internally and returned from {@link request}. It represents an in-progress request whose header has already been queued. The header is still mutable using the setHeader(name, value), getHeader(name), removeHeader(name) API. The actual header will be sent along with the first data chunk or when calling request.end().

ClientRequestArgs

sealed external interface ClientRequestArgs

HttpStatusCodes

sealed external interface HttpStatusCodes

IncomingHttpHeaders

external interface IncomingHttpHeaders : Record<String, Any>

IncomingMessage

open external class IncomingMessage : Readable

An IncomingMessage object is created by {@link Server} or {@link ClientRequest} and passed as the first argument to the 'request' and 'response' event respectively. It may be used to access response status, headers, and data.

InformationEvent

sealed external interface InformationEvent

OutgoingHttpHeader

typealias OutgoingHttpHeader = Any

OutgoingHttpHeaders

sealed external interface OutgoingHttpHeaders : Record<String, OutgoingHttpHeader>

OutgoingMessage

open external class OutgoingMessage<Request : IncomingMessage> : Writable

This class serves as the parent class of {@link ClientRequest} and {@link ServerResponse}. It is an abstract outgoing message from the perspective of the participants of an HTTP transaction.

RequestListener

typealias RequestListener<Request, Response> = (req: Request, res: Response) -> Unit

RequestOptions

external interface RequestOptions : ClientRequestArgs

Server

open external class Server<Request : IncomingMessage, Response : ServerResponse<*>> : Server

ServerOptions

external interface ServerOptions<Request : IncomingMessage, Response : ServerResponse<*>>

ServerResponse

external class ServerResponse<Request : IncomingMessage> : OutgoingMessage<Request>

This object is created internally by an HTTP server, not by the user. It is passed as the second parameter to the 'request' event.

Properties

globalAgent

external var globalAgent: Agent

Global instance of Agent which is used as the default for all HTTP client requests. Diverges from a default Agent configuration by having keepAlive enabled and a timeout of 5 seconds.

maxHeaderSize

external val maxHeaderSize: Double

Read-only property specifying the maximum allowed size of HTTP headers in bytes. Defaults to 16KB. Configurable using the --max-http-header-size CLI option.

METHODS

external val METHODS: ReadonlyArray<String>

STATUS_CODES

external val STATUS_CODES: HttpStatusCodes

Functions

createServer

external fun <Request : IncomingMessage, Response : ServerResponse<*>> createServer(requestListener: RequestListener<Request, Response> = definedExternally): Server<Request, Response>

Returns a new instance of {@link Server}.

external fun <Request : IncomingMessage, Response : ServerResponse<*>> createServer(options: ServerOptions<Request, Response>, requestListener: RequestListener<Request, Response> = definedExternally): Server<Request, Response>

get

external fun get(options: String, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

external fun get(options: RequestOptions, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

external fun get(options: URL, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

Since most requests are GET requests without bodies, Node.js provides this convenience method. The only difference between this method and {@link request} is that it sets the method to GET by default and calls req.end() automatically. The callback must take care to consume the response data for reasons stated in {@link ClientRequest} section.

external fun get(url: String, options: RequestOptions, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

external fun get(url: URL, options: RequestOptions, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

request

external fun request(options: String, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

external fun request(options: RequestOptions, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

external fun request(options: URL, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

options in socket.connect() are also supported.

external fun request(url: String, options: RequestOptions, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

external fun request(url: URL, options: RequestOptions, callback: (res: IncomingMessage) -> Unit = definedExternally): ClientRequest

setMaxIdleHTTPParsers

external fun setMaxIdleHTTPParsers(max: Number)

Set the maximum number of idle HTTP parsers.

validateHeaderName

external fun validateHeaderName(name: String)

Performs the low-level validations on the provided name that are done when res.setHeader(name, value) is called.

validateHeaderValue

external fun validateHeaderValue(name: String, value: String)

Performs the low-level validations on the provided value that are done when res.setHeader(name, value) is called.