# Interface: ConnectOptions

# Hierarchy

  • ConnectOptions

    ConnectOptions

# Properties

# Optional analyticsTimeout

analyticsTimeout? : undefined | number

Inherited from ConnectOptions.analyticsTimeout

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


# Optional authenticator

authenticator? : Authenticator

Inherited from ConnectOptions.authenticator

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


# bucketName

bucketName: string


# connectionString

connectionString: string


# Optional kvDurableTimeout

kvDurableTimeout? : undefined | number

Inherited from ConnectOptions.kvDurableTimeout

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


# Optional kvTimeout

kvTimeout? : undefined | number

Inherited from ConnectOptions.kvTimeout

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


# Optional logFunc

logFunc? : LogFunc

Inherited from ConnectOptions.logFunc

Specifies a logging function to use when outputting logging.


# Optional managementTimeout

managementTimeout? : undefined | number

Inherited from ConnectOptions.managementTimeout

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


# Optional meter

meter? : Meter

Inherited from ConnectOptions.meter

Specifies the meter to use for diagnostics metrics.


# Optional password

password? : undefined | string

Inherited from ConnectOptions.password

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

see ConnectOptions.username


# Optional queryTimeout

queryTimeout? : undefined | number

Inherited from ConnectOptions.queryTimeout

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


# Optional searchTimeout

searchTimeout? : undefined | number

Inherited from ConnectOptions.searchTimeout

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


# Optional tracer

tracer? : RequestTracer

Inherited from ConnectOptions.tracer

Specifies the tracer to use for diagnostics tracing.


# Optional transcoder

transcoder? : Transcoder

Inherited from ConnectOptions.transcoder

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


# Optional trustStorePath

trustStorePath? : undefined | string

Inherited from ConnectOptions.trustStorePath

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? : undefined | string

Inherited from ConnectOptions.username

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


# Optional viewTimeout

viewTimeout? : undefined | number

Inherited from ConnectOptions.viewTimeout

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