Constructors
constructor
- new UserDataService(db, collectionName): UserDataService
Parameters
db: Db
collectionName: string
Methods
changeUserEmail
- changeUserEmail(l, id, u): Promise<{
id: string;
}> Returns Promise<{
id: string;
}>
checkPassword
- checkPassword(l, payload, opts): Promise<{
valid: false;
} | {
id: string;
valid: true;
}> Parameters
l: Logger
payload: {
email: string;
password: string;
}
email: string
password: string
opts: {
maxFailedLoginAttempts: number;
}
maxFailedLoginAttempts: number
Returns Promise<{
valid: false;
} | {
id: string;
valid: true;
}>
createUser
- createUser(l, u): Promise<{
id: string;
}> Returns Promise<{
id: string;
}>
deleteUser
- deleteUser(l, id): Promise<boolean>
Returns Promise<boolean>
expandUserCustomFields
- expandUserCustomFields(l, user, customFieldDefinitions, customFieldsToExpand): Promise<UserEntity>
Parameters
l: Logger
customFieldDefinitions: CustomField[]
customFieldsToExpand: Record<string, boolean>
expandUserListCustomFields
- expandUserListCustomFields(l, userList, customFieldDefinitions, customFieldsToExpand): Promise<UserEntity[]>
Parameters
l: Logger
customFieldDefinitions: CustomField[]
customFieldsToExpand: Record<string, boolean>
getUserById
- getUserById(l, id): Promise<null | Omit<UserEntity, "password">>
Returns Promise<null | Omit<UserEntity, "password">>
getUsers
- getUsers(l, filter, orderParams, paginationOptions): Promise<PaginatedFindResult<UserEntity>>
Parameters
l: Logger
filter: undefined | Expression
orderParams: OrderParam<string>[]
paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<UserEntity>>
isExistingEmail
- isExistingEmail(l, email): Promise<boolean>
Returns Promise<boolean>
lockUser
- lockUser(l, id): Promise<{
id: string;
}> Returns Promise<{
id: string;
}>
passwordMatches
- passwordMatches(email, password): Promise<boolean>
Parameters
email: string
password: string
Returns Promise<boolean>
unlockUser
- unlockUser(l, id): Promise<{
id: string;
}> Returns Promise<{
id: string;
}>
updateUser
- updateUser(l, id, u): Promise<{
id: string;
}> Returns Promise<{
id: string;
}>
Description
Data service for user CRUD operations