Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConnectOptions

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

Hierarchy

  • ConnectOptions

Index

Properties

Optional analyticsTimeout

analyticsTimeout: number

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

Optional authenticator

authenticator: Authenticator

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

Optional kvDurableTimeout

kvDurableTimeout: number

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

Optional kvTimeout

kvTimeout: number

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

Optional logFunc

logFunc: LogFunc

Specifies a logging function to use when outputting logging.

Optional managementTimeout

managementTimeout: number

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

Optional meter

meter: Meter

Specifies the meter to use for diagnostics metrics.

Optional password

password: string

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

see

ConnectOptions.username

Optional queryTimeout

queryTimeout: number

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

Optional searchTimeout

searchTimeout: number

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

Optional tracer

Specifies the tracer to use for diagnostics tracing.

Optional transcoder

transcoder: Transcoder

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

Optional trustStorePath

trustStorePath: string

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

Optional username

username: string

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

Optional viewTimeout

viewTimeout: number

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

Generated using TypeDoc