Class MongoCredentials

constructor

• new MongoCredentials(options): MongoCredentials

• Parameters

  • options: MongoCredentialsOptions

  Returns MongoCredentials

Readonly mechanism

Readonly mechanismProperties

Readonly password

Readonly source

Readonly username

equals

• equals(other): boolean

• Determines if two MongoCredentials objects are equivalent

  Parameters

  • other: MongoCredentials

  Returns boolean

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

validate

• validate(): void

• Returns void

Static merge

• merge(creds, options): MongoCredentials

• Parameters

  • creds: undefined | MongoCredentials

  • options: Partial<MongoCredentialsOptions>

  Returns MongoCredentials