Class MongoAuthenticationOptions

Options configuring Mongo authentication.

Hierarchy

MongoAuthenticationOptions

Index

Constructors

constructor

Methods

Constructors

constructor

new MongoAuthenticationOptions(): MongoAuthenticationOptions
new MongoAuthenticationOptions(obj: MongoAuthenticationOptions | {}): MongoAuthenticationOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:143
Returns MongoAuthenticationOptions
- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:145
Parameters
- obj: MongoAuthenticationOptions | {}
Returns MongoAuthenticationOptions

Methods

getCollectionName

getCollectionName(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:152
The property name to be used to set the name of the collection inside the config.

Returns string

getPasswordCredentialField

getPasswordCredentialField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:159
Returns string

getPasswordField

getPasswordField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:166
The property name to be used to set the name of the field, where the password is stored inside

Returns string

getUsernameCredentialField

getUsernameCredentialField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:176
The property name to be used to set the name of the field, where the username for the credentials is stored inside.

Returns string

getUsernameField

getUsernameField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:186
The property name to be used to set the name of the field, where the username is stored inside.

Returns string

setCollectionName

setCollectionName(collectionName: string): MongoAuthenticationOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:157
The property name to be used to set the name of the collection inside the config.

Parameters
- collectionName: string
Returns MongoAuthenticationOptions

setPasswordCredentialField

setPasswordCredentialField(passwordCredentialField: string): MongoAuthenticationOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:161
Parameters
- passwordCredentialField: string
Returns MongoAuthenticationOptions

setPasswordField

setPasswordField(passwordField: string): MongoAuthenticationOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:171
The property name to be used to set the name of the field, where the password is stored inside

Parameters
- passwordField: string
Returns MongoAuthenticationOptions

setUsernameCredentialField

setUsernameCredentialField(usernameCredentialField: string): MongoAuthenticationOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:181
The property name to be used to set the name of the field, where the username for the credentials is stored inside.

Parameters
- usernameCredentialField: string
Returns MongoAuthenticationOptions

setUsernameField

setUsernameField(usernameField: string): MongoAuthenticationOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:191
The property name to be used to set the name of the field, where the username is stored inside.

Parameters
- usernameField: string
Returns MongoAuthenticationOptions

Generated using TypeDoc