Interface ConnectOptions

Specifies the options which can be specified when connecting to a cluster.

Hierarchy

  • ConnectOptions

Properties

authenticator?: Authenticator

Specifies a specific authenticator to use when connecting to the cluster.

configProfile?: string

Applies the specified ConfigProfile options to the cluster.

Volatile: This API is subject to change at any time.

dnsConfig?: DnsConfig

Specifies the DNS config for connections of this cluster.

Volatile: This API is subject to change at any time.

password?: string

Specifies a password to be used in concert with username for authentication.

See

ConnectOptions.username

security?: SecurityConfig

Specifies the security config for connections of this cluster.

timeouts?: TimeoutConfig

Specifies the default timeouts for various operations performed by the SDK.

transactions?: TransactionsConfig

Specifies the options for transactions.

transcoder?: Transcoder

Specifies the default transcoder to use when encoding or decoding document values.

username?: string

Specifies a username to use for an implicitly created IPasswordAuthenticator used for authentication with the cluster.

Generated using TypeDoc