Class MongoCredentials

A representation of the credentials used by MongoDB

Index

Constructors

Properties

mechanism mechanismProperties password source username

Methods

equals resolveAuthMechanism validate merge

Constructors

constructor

new MongoCredentials(options): MongoCredentials
Parameters
- options: MongoCredentialsOptions
Returns MongoCredentials
- Defined in src/cmap/auth/mongo_credentials.ts:99

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): boolean
Determines if two MongoCredentials objects are equivalent
Parameters
- other: MongoCredentials
Returns boolean
- Defined in src/cmap/auth/mongo_credentials.ts:141

resolveAuthMechanism

resolveAuthMechanism(hello): MongoCredentials
If the authentication mechanism is set to "default", resolves the authMechanism based on the server version and server supported sasl mechanisms.
Parameters
- hello: null | Document
  A hello response from the server
Returns MongoCredentials
- Defined in src/cmap/auth/mongo_credentials.ts:156

validate

validate(): void
Returns void
- Defined in src/cmap/auth/mongo_credentials.ts:171

`Static`merge

merge(creds, options): MongoCredentials
Parameters
- creds: undefined | MongoCredentials
- options: Partial<MongoCredentialsOptions>
Returns MongoCredentials
- Defined in src/cmap/auth/mongo_credentials.ts:270