Interface ConnectOptions

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

Hierarchy

  • ConnectOptions

Properties

analyticsTimeout?: number

Specifies the default timeout for analytics query operations, specified in millseconds.

authenticator?: Authenticator

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

kvDurableTimeout?: number

Specifies the default timeout for durable KV operations, specified in millseconds.

kvTimeout?: number

Specifies the default timeout for KV operations, specified in millseconds.

logFunc?: LogFunc

Specifies a logging function to use when outputting logging.

managementTimeout?: number

Specifies the default timeout for management operations, specified in millseconds.

meter?: Meter

Specifies the meter to use for diagnostics metrics.

password?: string

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

See

ConnectOptions.username

queryTimeout?: number

Specifies the default timeout for query operations, specified in millseconds.

searchTimeout?: number

Specifies the default timeout for search query operations, specified in millseconds.

tracer?: RequestTracer

Specifies the tracer to use for diagnostics tracing.

transcoder?: Transcoder

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

trustStorePath?: string

Specifies the path to a trust store file to be used when validating the authenticity of the server when connecting over SSL.

username?: string

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

viewTimeout?: number

Specifies the default timeout for views operations, specified in millseconds.

Generated using TypeDoc