AccountsBoostOptions

@accounts/boostGlobalsAccountsBoostOptions

Type parameters

CustomUser: User

Hierarchy

  • AccountsServerOptions

    AccountsBoostOptions

Index

Properties

Properties

Optional ambiguousErrorMessages

ambiguousErrorMessages? : boolean

Inherited from AccountsBoostOptions.ambiguousErrorMessages

Defined in server/lib/types/accounts-server-options.d.ts:14

Return ambiguous error messages from login failures to prevent user enumeration. Defaults to true.


Optional createJwtPayload

createJwtPayload? : function

Inherited from AccountsBoostOptions.createJwtPayload

Defined in server/lib/types/accounts-server-options.d.ts:39

Function to add addition information in jwt payload of accessToken

Type declaration:

▸ (data: JwtData, user: CustomUser): Promise‹Record‹string, any››

Parameters:

NameType
dataJwtData
userCustomUser

Optional createNewSessionTokenOnRefresh

createNewSessionTokenOnRefresh? : boolean

Inherited from AccountsBoostOptions.createNewSessionTokenOnRefresh

Defined in server/lib/types/accounts-server-options.d.ts:35

Creates a new session token each time a user refreshes his access token


Optional db

db? : DatabaseInterface‹CustomUser›

Inherited from AccountsBoostOptions.db

Defined in server/lib/types/accounts-server-options.d.ts:15


Optional emailTemplates

emailTemplates? : EmailTemplatesType

Inherited from AccountsBoostOptions.emailTemplates

Defined in server/lib/types/accounts-server-options.d.ts:24


Optional enableAutologin

enableAutologin? : boolean

Inherited from AccountsBoostOptions.enableAutologin

Defined in server/lib/types/accounts-server-options.d.ts:44

If this flag is set to true - user will be automatically logged in after registration. LoginResult data will be included into registration response.


Optional impersonationAuthorize

impersonationAuthorize? : function

Inherited from AccountsBoostOptions.impersonationAuthorize

Defined in server/lib/types/accounts-server-options.d.ts:26

Type declaration:

▸ (user: User, impersonateToUser: User): Promise‹any›

Parameters:

NameType
userUser
impersonateToUserUser

Optional micro

micro? : boolean

Defined in boost/src/index.ts:20


Optional prepareMail

prepareMail? : PrepareMailFunction

Inherited from AccountsBoostOptions.prepareMail

Defined in server/lib/types/accounts-server-options.d.ts:29


Optional resumeSessionValidator

resumeSessionValidator? : ResumeSessionValidator

Inherited from AccountsBoostOptions.resumeSessionValidator

Defined in server/lib/types/accounts-server-options.d.ts:27


Optional sendMail

sendMail? : SendMailType

Inherited from AccountsBoostOptions.sendMail

Defined in server/lib/types/accounts-server-options.d.ts:30


Optional siteUrl

siteUrl? : string

Inherited from AccountsBoostOptions.siteUrl

Defined in server/lib/types/accounts-server-options.d.ts:28


Optional storage

storage? : object

Defined in boost/src/index.ts:16

Type declaration:

  • name? : string

  • uri? : string


Optional tokenConfigs

tokenConfigs? : object

Inherited from AccountsBoostOptions.tokenConfigs

Defined in server/lib/types/accounts-server-options.d.ts:20

Type declaration:

  • accessToken? : SignOptions

  • refreshToken? : SignOptions


Optional tokenCreator

tokenCreator? : TokenCreator

Inherited from AccountsBoostOptions.tokenCreator

Defined in server/lib/types/accounts-server-options.d.ts:31


tokenSecret

tokenSecret: string | object

Inherited from AccountsBoostOptions.tokenSecret

Defined in server/lib/types/accounts-server-options.d.ts:16


Optional useInternalUserObjectSanitizer

useInternalUserObjectSanitizer? : boolean

Inherited from AccountsBoostOptions.useInternalUserObjectSanitizer

Defined in server/lib/types/accounts-server-options.d.ts:49

Set this false to false if you wish to skip internal user sanitazing method, and expose the original User object as-is.


Optional userObjectSanitizer

userObjectSanitizer? : UserObjectSanitizerFunction

Inherited from AccountsBoostOptions.userObjectSanitizer

Defined in server/lib/types/accounts-server-options.d.ts:25