• Public
  • Public/Protected
  • All

Interface MongoOptions

Mongo Client Options


  • Required<Pick<MongoClientOptions, "autoEncryption" | "compressors" | "connectTimeoutMS" | "directConnection" | "driverInfo" | "forceServerObjectId" | "minHeartbeatFrequencyMS" | "heartbeatFrequencyMS" | "keepAlive" | "keepAliveInitialDelay" | "localThresholdMS" | "logger" | "maxIdleTimeMS" | "maxPoolSize" | "minPoolSize" | "monitorCommands" | "noDelay" | "pkFactory" | "promiseLibrary" | "raw" | "replicaSet" | "retryReads" | "retryWrites" | "serverSelectionTimeoutMS" | "socketTimeoutMS" | "tlsAllowInvalidCertificates" | "tlsAllowInvalidHostnames" | "tlsInsecure" | "waitQueueTimeoutMS" | "zlibCompressionLevel">>
  • SupportedNodeConnectionOptions
    • MongoOptions



Optional ALPNProtocols

ALPNProtocols: Uint8Array | string[] | Uint8Array[]

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

Optional autoEncrypter

autoEncrypter: AutoEncrypter


autoEncryption: AutoEncryptionOptions

Optionally enable client side auto encryption


Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

Automatic encryption requires the authenticated user to have the listCollections privilege action.

If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

  • AutoEncryptionOptions.keyVaultClient is not passed.
  • AutoEncryptionOptions.bypassAutomaticEncryption is false.

If an internal MongoClient is created, it is configured with the same options as the parent MongoClient except minPoolSize is set to 0 and AutoEncryptionOptions is omitted.

Optional ca

ca: string | Buffer | (string | Buffer)[]

Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

Optional cert

cert: string | Buffer | (string | Buffer)[]

Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

Optional checkServerIdentity

checkServerIdentity: (host: string, cert: PeerCertificate) => Error | undefined

Type declaration

    • (host: string, cert: PeerCertificate): Error | undefined
    • Parameters

      • host: string
      • cert: PeerCertificate

      Returns Error | undefined

Optional ciphers

ciphers: string

Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.


compressors: ("none" | "snappy" | "zlib")[]

Comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance.


connectTimeoutMS: number

The time in milliseconds to attempt a connection before timing out.

Optional connectionType

connectionType: typeof Connection

Optional credentials

credentials: MongoCredentials

Optional crl

crl: string | Buffer | (string | Buffer)[]

PEM formatted CRLs (Certificate Revocation Lists).


dbName: string


directConnection: boolean

Allow a driver to force a Single topology type with a connection string containing one host


driverInfo: DriverInfo

Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver

Optional ecdhCurve

ecdhCurve: string

A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.


encrypter: Encrypter

Optional family

family: number


forceServerObjectId: boolean

Force server to assign _id values instead of driver


heartbeatFrequencyMS: number

heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.

Optional hints

hints: number


hosts: HostAddress[]


keepAlive: boolean

TCP Connection keep alive enabled


keepAliveInitialDelay: number

The number of milliseconds to wait before initiating keepAlive on the TCP socket

Optional key

key: string | Buffer | (Buffer | KeyObject)[]

Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

Optional localAddress

localAddress: string

Optional localPort

localPort: number


localThresholdMS: number

The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.


logger: Logger

Custom logger object

Optional lookup

lookup: LookupFunction


maxIdleTimeMS: number

The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.


maxPoolSize: number

The maximum number of connections in the connection pool.


metadata: ClientMetadata

Optional minDHSize

minDHSize: number


minHeartbeatFrequencyMS: number

Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.


minPoolSize: number

The minimum number of connections in the connection pool.


monitorCommands: boolean

Enable command monitoring for this client


noDelay: boolean

TCP Connection no delay

Optional passphrase

passphrase: string

Shared passphrase used for a single private key and/or a PFX.

Optional pfx

pfx: string | Buffer | (string | Buffer | PxfObject)[]

PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.


pkFactory: PkFactory

A primary key factory function for generation of custom _id keys


promiseLibrary: any

A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible


raw: boolean

Return document results as raw BSON buffers


readConcern: ReadConcern


readPreference: ReadPreference

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.




replicaSet: string

Specifies the name of the replica set, if the mongod is a member of a replica set.


retryReads: boolean

Enables retryable reads.


retryWrites: boolean

Enable retryable writes.

Optional secureContext

secureContext: SecureContext

An optional TLS context object from tls.createSecureContext()

Optional secureProtocol

secureProtocol: string

Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.


serverApi: ServerApi


serverSelectionTimeoutMS: number

Specifies how long (in milliseconds) to block for server selection before throwing an exception.

Optional servername

servername: string

Optional session

session: Buffer


socketTimeoutMS: number

The time in milliseconds to attempt a send or receive on a socket before the attempt times out.

Optional srvHost

srvHost: string


tls: boolean

If set TLS enabled, equivalent to setting the ssl option.

Additional options:

nodejs option MongoDB equivalent type
ca sslCA, tlsCAFile string | Buffer | Buffer[]
crl sslCRL string | Buffer | Buffer[]
cert sslCert, tlsCertificateFile, tlsCertificateKeyFile string | Buffer | Buffer[]
key sslKey, tlsCertificateKeyFile string | Buffer | KeyObject[]
passphrase sslPass, tlsCertificateKeyFilePassword string
rejectUnauthorized sslValidate boolean


tlsAllowInvalidCertificates: boolean

Bypasses validation of the certificates presented by the mongod/mongos instance


tlsAllowInvalidHostnames: boolean

Disables hostname validation of the certificate presented by the mongod/mongos instance.


tlsInsecure: boolean

Disables various certificate validations.


userSpecifiedAuthSource: boolean


userSpecifiedReplicaSet: boolean


waitQueueTimeoutMS: number

The maximum time in milliseconds that a thread can wait for a connection to become available.


writeConcern: WriteConcern


zlibCompressionLevel: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

An integer that specifies the compression level if using zlib for network compression.



  • toURI(): string

Generated using TypeDoc