Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InitOptions

For complete available options :

Base InitOptions:

Others options are shared between ServerOptions and SecureServerOptions

If you need use your own ssl certificates :

You can eventually need to :

see

https://nodejs.org/api/http.html#http_http_createserver_options_requestlistener

see

https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener

see

https://nodejs.org/api/http2.html#http2_http2_createserver_options_onrequesthandler

see

https://nodejs.org/api/http2.html#http2_http2_createsecureserver_options_onrequesthandler

Hierarchy

Index

Properties

Properties

Optional ALPNProtocols

ALPNProtocols: string[] | Uint8Array[] | Uint8Array

An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

Optional Http1IncomingMessage

Http1IncomingMessage: IncomingMessage

Optional Http1ServerResponse

Http1ServerResponse: ServerResponse

Optional Http2ServerRequest

Http2ServerRequest: Http2ServerRequest

Optional Http2ServerResponse

Http2ServerResponse: Http2ServerResponse

Optional IncomingMessage

IncomingMessage: IncomingMessage

Optional SNICallback

SNICallback: function

SNICallback(servername, cb) A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).

Type declaration

    • (servername: string, cb: function): void

    • Parameters

      • servername: string
      • cb: function

      Returns void

Optional ServerResponse

ServerResponse: ServerResponse

Optional allowHTTP1

allowHTTP1: boolean

Optional ca

ca: string | Buffer | Array<string | Buffer>

Optional cert

cert: string | Buffer | Array<string | Buffer>

Optional ciphers

ciphers: string

Optional clientCertEngine

clientCertEngine: string

Optional createConnection

createConnection: function

Type declaration

Optional crl

crl: string | Buffer | Array<string | Buffer>

Optional dhparam

dhparam: string | Buffer

Optional ecdhCurve

ecdhCurve: string

Optional enableTrace

enableTrace: boolean

When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

default

false

Optional handshakeTimeout

handshakeTimeout: number

Optional honorCipherOrder

honorCipherOrder: boolean

Optional http2Secure

http2Secure: boolean

If you use http2 protocol You should choose between a server with or without TLS layer

Disable it is highly discouraged because majority of navigator disallow http2 without a secure layer

default

true

Optional key

key: string | Buffer | Array<Buffer | Object>

Optional maxDeflateDynamicTableSize

maxDeflateDynamicTableSize: number

Optional maxHeaderListPairs

maxHeaderListPairs: number

Optional maxOutstandingPings

maxOutstandingPings: number

Optional maxSendHeaderBlockLength

maxSendHeaderBlockLength: number

Optional maxSessionMemory

maxSessionMemory: number

Optional maxVersion

maxVersion: SecureVersion

Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

Optional minVersion

minVersion: SecureVersion

Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

Optional origins

origins: string[]

Optional paddingStrategy

paddingStrategy: number

Optional passphrase

passphrase: string

Optional peerMaxConcurrentStreams

peerMaxConcurrentStreams: number

Optional pfx

pfx: string | Buffer | Array<string | Buffer | Object>

Optional protocol

protocol: "http" | "https" | "http2"

The server protocol

default

'http'

Optional rejectUnauthorized

rejectUnauthorized: boolean

If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

default

true

Optional requestCert

requestCert: boolean

If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

Optional secureContext

secureContext: SecureContext

An optional TLS context object from tls.createSecureContext()

Optional secureOptions

secureOptions: number

Optional secureProtocol

secureProtocol: string

Optional selectPadding

selectPadding: function

Type declaration

    • (frameLen: number, maxFrameLen: number): number

    • Parameters

      • frameLen: number
      • maxFrameLen: number

      Returns number

Optional selfSigned

selfSigned: boolean

Set to true if you want a self signed ssl certificate Generated for runtime.

default

false

Optional sessionIdContext

sessionIdContext: string

Optional sessionTimeout

sessionTimeout: number

Optional settings

settings: Settings

Optional ticketKeys

ticketKeys: Buffer

Generated using TypeDoc