Mongo

@accounts/mongo › Globals › Mongo

Hierarchy

• Mongo

Implements

• DatabaseInterface

Index

Constructors

• constructor

Methods

• addEmail
• addEmailVerificationToken
• addResetPasswordToken
• createSession
• createUser
• findPasswordHash
• findSessionById
• findSessionByToken
• findUserByEmail
• findUserByEmailVerificationToken
• findUserById
• findUserByResetPasswordToken
• findUserByServiceId
• findUserByUsername
• invalidateAllSessions
• invalidateSession
• removeAllResetPasswordTokens
• removeEmail
• setPassword
• setService
• setUserDeactivated
• setUsername
• setupIndexes
• unsetService
• updateSession
• verifyEmail

Constructors

constructor

+ new Mongo(db: any, options: AccountsMongoOptions): Mongo

Defined in mongo.ts:42

Parameters:

Name	Type	Default
db	any	-
options	AccountsMongoOptions	{}

Returns: Mongo

Methods

addEmail

▸ addEmail(userId: string, newEmail: string, verified: boolean): Promise‹void›

Defined in mongo.ts:95

Parameters:

Name	Type
userId	string
newEmail	string
verified	boolean

Returns: Promise‹void›

---

addEmailVerificationToken

▸ addEmailVerificationToken(userId: string, email: string, token: string): Promise‹void›

Defined in mongo.ts:119

Parameters:

Name	Type
userId	string
email	string
token	string

Returns: Promise‹void›

---

addResetPasswordToken

▸ addResetPasswordToken(userId: string, email: string, token: string, reason: string): Promise‹void›

Defined in mongo.ts:127

Parameters:

Name	Type
userId	string
email	string
token	string
reason	string

Returns: Promise‹void›

---

createSession

▸ createSession(userId: string, token: string, connection: ConnectionInformations, extraData?: object): Promise‹string›

Defined in mongo.ts:136

Parameters:

Name	Type	Default
userId	string	-
token	string	-
connection	ConnectionInformations	{}
extraData?	object	-

Returns: Promise‹string›

---

createUser

▸ createUser(user: CreateUserServicePassword): Promise‹string›

Defined in mongo.ts:72

Parameters:

Name	Type
user	CreateUserServicePassword

Returns: Promise‹string›

---

findPasswordHash

▸ findPasswordHash(userId: string): Promise‹string | null›

Defined in mongo.ts:83

Parameters:

Name	Type
userId	string

Returns: Promise‹string | null›

---

findSessionById

▸ findSessionById(sessionId: string): Promise‹Session | null›

Defined in mongo.ts:145

Parameters:

Name	Type
sessionId	string

Returns: Promise‹Session | null›

---

findSessionByToken

▸ findSessionByToken(token: string): Promise‹Session | null›

Defined in mongo.ts:149

Parameters:

Name	Type
token	string

Returns: Promise‹Session | null›

---

findUserByEmail

▸ findUserByEmail(email: string): Promise‹User | null›

Defined in mongo.ts:76

Parameters:

Name	Type
email	string

Returns: Promise‹User | null›

---

findUserByEmailVerificationToken

▸ findUserByEmailVerificationToken(token: string): Promise‹User | null›

Defined in mongo.ts:87

Parameters:

Name	Type
token	string

Returns: Promise‹User | null›

---

findUserById

▸ findUserById(userId: string): Promise‹User | null›

Defined in mongo.ts:68

Parameters:

Name	Type
userId	string

Returns: Promise‹User | null›

---

findUserByResetPasswordToken

▸ findUserByResetPasswordToken(token: string): Promise‹User | null›

Defined in mongo.ts:91

Parameters:

Name	Type
token	string

Returns: Promise‹User | null›

---

findUserByServiceId

▸ findUserByServiceId(serviceName: string, serviceId: string): Promise‹User | null›

Defined in mongo.ts:169

Parameters:

Name	Type
serviceName	string
serviceId	string

Returns: Promise‹User | null›

---

findUserByUsername

▸ findUserByUsername(username: string): Promise‹User | null›

Defined in mongo.ts:79

Parameters:

Name	Type
username	string

Returns: Promise‹User | null›

---

invalidateAllSessions

▸ invalidateAllSessions(userId: string, excludedSessionIds?: string[]): Promise‹void›

Defined in mongo.ts:165

Parameters:

Name	Type
userId	string
excludedSessionIds?	string[]

Returns: Promise‹void›

---

invalidateSession

▸ invalidateSession(sessionId: string): Promise‹void›

Defined in mongo.ts:161

Parameters:

Name	Type
sessionId	string

Returns: Promise‹void›

---

removeAllResetPasswordTokens

▸ removeAllResetPasswordTokens(userId: string): Promise‹void›

Defined in mongo.ts:115

Parameters:

Name	Type
userId	string

Returns: Promise‹void›

---

removeEmail

▸ removeEmail(userId: string, email: string): Promise‹void›

Defined in mongo.ts:99

Parameters:

Name	Type
userId	string
email	string

Returns: Promise‹void›

---

setPassword

▸ setPassword(userId: string, newPassword: string): Promise‹void›

Defined in mongo.ts:111

Parameters:

Name	Type
userId	string
newPassword	string

Returns: Promise‹void›

---

setService

▸ setService(userId: string, serviceName: string, service: object): Promise‹void›

Defined in mongo.ts:179

Parameters:

Name	Type
userId	string
serviceName	string
service	object

Returns: Promise‹void›

---

setUserDeactivated

▸ setUserDeactivated(userId: string, deactivated: boolean): Promise‹void›

Defined in mongo.ts:207

Parameters:

Name	Type
userId	string
deactivated	boolean

Returns: Promise‹void›

---

setUsername

▸ setUsername(userId: string, newUsername: string): Promise‹void›

Defined in mongo.ts:107

Parameters:

Name	Type
userId	string
newUsername	string

Returns: Promise‹void›

---

setupIndexes

▸ setupIndexes(options: Omit‹IndexOptions, "unique" | "sparse"›): Promise‹void›

Defined in mongo.ts:63

Setup the mongo indexes needed.

Parameters:

Name	Type	Default	Description
options	Omit‹IndexOptions, "unique" | "sparse"›	{}	Options passed to the mongo native createIndex method.

Returns: Promise‹void›

---

unsetService

▸ unsetService(userId: string, serviceName: string): Promise‹void›

Defined in mongo.ts:192

Parameters:

Name	Type
userId	string
serviceName	string

Returns: Promise‹void›

---

updateSession

▸ updateSession(sessionId: string, connection: ConnectionInformations, newToken?: string): Promise‹void›

Defined in mongo.ts:153

Parameters:

Name	Type
sessionId	string
connection	ConnectionInformations
newToken?	string

Returns: Promise‹void›

---

verifyEmail

▸ verifyEmail(userId: string, email: string): Promise‹void›

Defined in mongo.ts:103

Parameters:

Name	Type
userId	string
email	string

Returns: Promise‹void›