Skip to content

ServerOptions

[<Interface>]
type ServerOptions<'Request, 'Response when 'Request :> IncomingMessageConstructor> =
    abstract member IncomingMessage: 'Request option with get, set
    abstract member ServerResponse: 'Response option with get, set
    abstract member connectionsCheckingInterval: float option with get, set
    abstract member headersTimeout: float option with get, set
    abstract member highWaterMark: float option with get, set
    abstract member insecureHTTPParser: bool option with get, set
    abstract member joinDuplicateHeaders: bool option with get, set
    abstract member keepAlive: bool option with get, set
    abstract member keepAliveInitialDelay: float option with get, set
    abstract member keepAliveTimeout: float option with get, set
    abstract member keepAliveTimeoutBuffer: float option with get, set
    abstract member maxHeaderSize: float option with get, set
    abstract member noDelay: bool option with get, set
    abstract member rejectNonStandardBodyWrites: bool option with get, set
    abstract member requestTimeout: float option with get, set
    abstract member requireHostHeader: bool option with get, set
    abstract member uniqueHeaders: U2<string,string array> array option with get, set
    static member Create (?IncomingMessage: 'Request, ?ServerResponse: 'Response, ?requestTimeout: float, ?joinDuplicateHeaders: bool, ?keepAliveTimeout: float, ?keepAliveTimeoutBuffer: float, ?connectionsCheckingInterval: float, ?headersTimeout: float, ?highWaterMark: float, ?insecureHTTPParser: bool, ?maxHeaderSize: float, ?noDelay: bool, ?requireHostHeader: bool, ?keepAlive: bool, ?keepAliveInitialDelay: float, ?uniqueHeaders: U2<string,string array> array, ?rejectNonStandardBodyWrites: bool) : ServerOptions<'Request,'Response>
AssemblyXantham.Fable.Node
Attributes[<Interface>]

Properties

abstract member IncomingMessage: 'Request option with get, set

Specifies the IncomingMessage class to be used. Useful for extending the original IncomingMessage.

abstract member ServerResponse: 'Response option with get, set

Specifies the ServerResponse class to be used. Useful for extending the original ServerResponse.

abstract member connectionsCheckingInterval: float option with get, set

Sets the interval value in milliseconds to check for request and headers timeout in incomplete requests.

abstract member headersTimeout: float option with get, set

Sets the timeout value in milliseconds for receiving the complete HTTP headers from the client. See Server.headersTimeout for more information.

@since 18.0.0

abstract member highWaterMark: float option with get, set

Optionally overrides all sockets' readableHighWaterMark and writableHighWaterMark. This affects highWaterMark property of both IncomingMessage and ServerResponse. Default:

@see stream.getDefaultHighWaterMark ().

abstract member insecureHTTPParser: bool option with get, set

Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.

abstract member joinDuplicateHeaders: bool option with get, set

It joins the field line values of multiple headers in a request with , instead of discarding the duplicates.

@since v18.14.0

abstract member keepAlive: bool option with get, set

If set to true, it enables keep-alive functionality on the socket immediately after a new incoming connection is received, similarly on what is done in socket.setKeepAlive([enable][, initialDelay]).

@since v16.5.0

abstract member keepAliveInitialDelay: float option with get, set

If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.

@since v16.5.0

abstract member keepAliveTimeout: float option with get, set

The number of milliseconds of inactivity a server needs to wait for additional incoming data, after it has finished writing the last response, before a socket will be destroyed.

@see Server.keepAliveTimeout for more information.

abstract member keepAliveTimeoutBuffer: float option with get, set

An additional buffer time added to the server.keepAliveTimeout to extend the internal socket timeout.

@since 22.19.0

abstract member maxHeaderSize: float option with get, set

Optionally overrides the value of --max-http-header-size for requests received by this server, i.e. the maximum length of request headers in bytes.

@since v13.3.0

abstract member noDelay: bool option with get, set

If set to true, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.

@since v16.5.0

abstract member rejectNonStandardBodyWrites: bool option with get, set

If set to true, an error is thrown when writing to an HTTP response which does not have a body.

@since v18.17.0, v20.2.0

abstract member requestTimeout: float option with get, set

Sets the timeout value in milliseconds for receiving the entire request from the client.

@see Server.requestTimeout for more information.

abstract member requireHostHeader: bool option with get, set

If set to true, it forces the server to respond with a 400 (Bad Request) status code to any HTTP/1.1 request message that lacks a Host header (as mandated by the specification).

@since 20.0.0

abstract member uniqueHeaders: U2<string,string array> array option with get, set

A list of response headers that should be sent only once. If the header's value is an array, the items will be joined using ; .

Methods

static member Create (?IncomingMessage: 'Request, ?ServerResponse: 'Response, ?requestTimeout: float, ?joinDuplicateHeaders: bool, ?keepAliveTimeout: float, ?keepAliveTimeoutBuffer: float, ?connectionsCheckingInterval: float, ?headersTimeout: float, ?highWaterMark: float, ?insecureHTTPParser: bool, ?maxHeaderSize: float, ?noDelay: bool, ?requireHostHeader: bool, ?keepAlive: bool, ?keepAliveInitialDelay: float, ?uniqueHeaders: U2<string,string array> array, ?rejectNonStandardBodyWrites: bool) : ServerOptions<'Request,'Response>