Interface ConnectOptions

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

Hierarchy

  • ConnectOptions

Properties

authenticator? password? security? timeouts? transactions? transcoder? username?

Properties

Optional authenticator

authenticator?: Authenticator

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

Optional password

password?: string

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

See

ConnectOptions.username

Optional security

security?: SecurityConfig

Specifies the security config for connections of this cluster.

Optional timeouts

timeouts?: TimeoutConfig

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

Optional transactions

transactions?: TransactionsConfig

Specifies the options for transactions.

Optional transcoder

transcoder?: Transcoder

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

Optional username

username?: string

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

Settings

Member Visibility

Theme

Generated using TypeDoc