Class MongoCredentials

A representation of the credentials used by MongoDB

Hierarchy

MongoCredentials

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MongoCredentials(options: MongoCredentialsOptions): MongoCredentials

- Defined in src/cmap/auth/mongo_credentials.ts:64
Parameters
- options: MongoCredentialsOptions
Returns MongoCredentials

Properties

Readonly mechanism

mechanism: AuthMechanism

The method used to authenticate

Readonly mechanismProperties

mechanismProperties: AuthMechanismProperties

Special properties used by some types of auth mechanisms

Readonly password

password: string

The password used for authentication

Readonly source

source: string

The database that the user should authenticate against

Readonly username

username: string

The username used for authentication

Methods

equals

equals(other: MongoCredentials): boolean

- Defined in src/cmap/auth/mongo_credentials.ts:107
Determines if two MongoCredentials objects are equivalent

Parameters
- other: MongoCredentials
Returns boolean

resolveAuthMechanism

resolveAuthMechanism(hello?: Document): MongoCredentials

- Defined in src/cmap/auth/mongo_credentials.ts:122
If the authentication mechanism is set to "default", resolves the authMechanism based on the server version and server supported sasl mechanisms.

Parameters
- Optional hello: Document
  
  A hello response from the server
Returns MongoCredentials

validate

validate(): void

- Defined in src/cmap/auth/mongo_credentials.ts:137
Returns void

Static merge

merge(creds: undefined | MongoCredentials, options: Partial<MongoCredentialsOptions>): MongoCredentials

- Defined in src/cmap/auth/mongo_credentials.ts:178
Parameters
- creds: undefined | MongoCredentials
- options: Partial<MongoCredentialsOptions>
Returns MongoCredentials

Generated using TypeDoc