Type alias UsersModule

Type declaration

• addRoles: ((userId: string, roles: string[]) => Promise<number>)

  • • (userId: string, roles: string[]): Promise<number>

    • Parameters

      • userId: string

      • roles: string[]

      Returns Promise<number>

• count: ((query: UserQuery) => Promise<number>)

  • • (query: UserQuery): Promise<number>

    • Parameters

      • query: UserQuery

      Returns Promise<number>

• findUser: ((selector: UserQuery & { sort?: SortOption[] }, options?: FindOptions) => Promise<User>)

  • • (selector: UserQuery & { sort?: SortOption[] }, options?: FindOptions): Promise<User>

    • Parameters

      • selector: UserQuery & { sort?: SortOption[] }

      • Optional options: FindOptions

      Returns Promise<User>

• findUserById: ((userId: _ID) => Promise<User>)

  • • (userId: _ID): Promise<User>

    • Parameters

      • userId: _ID

      Returns Promise<User>

• findUserByToken: ((query: { hashedToken?: string; resetToken?: string }) => Promise<User>)

  • • (query: { hashedToken?: string; resetToken?: string }): Promise<User>

    • Parameters

      • query: { hashedToken?: string; resetToken?: string }

        • Optional hashedToken?: string

        • Optional resetToken?: string

      Returns Promise<User>

• findUsers: ((query: UserQuery & { limit?: number; offset?: number; sort?: SortOption[] }) => Promise<User[]>)

  • • (query: UserQuery & { limit?: number; offset?: number; sort?: SortOption[] }): Promise<User[]>

    • Parameters

      • query: UserQuery & { limit?: number; offset?: number; sort?: SortOption[] }

      Returns Promise<User[]>

• primaryEmail: ((user: User) => Email)

  • • (user: User): Email

    • Parameters

      • user: User

      Returns Email

• updateAvatar: ((_id: string, fileId: string, userId: string) => Promise<User>)

  • • (_id: string, fileId: string, userId: string): Promise<User>

    • Parameters

      • _id: string

      • fileId: string

      • userId: string

      Returns Promise<User>

• updateGuest: ((user: User, guest: boolean) => Promise<void>)

  • • (user: User, guest: boolean): Promise<void>

    • Parameters

      • user: User

      • guest: boolean

      Returns Promise<void>

• updateHeartbeat: ((userId: string, doc: UserLastLogin) => Promise<User>)

  • • (userId: string, doc: UserLastLogin): Promise<User>

    • Parameters

      • userId: string

      • doc: UserLastLogin

      Returns Promise<User>

• updateInitialPassword: ((user: User, initialPassword: boolean) => Promise<void>)

  • • (user: User, initialPassword: boolean): Promise<void>

    • Parameters

      • user: User

      • initialPassword: boolean

      Returns Promise<void>

• updateLastBillingAddress: ((_id: string, lastAddress: Address, userId: string) => Promise<User>)

  • • (_id: string, lastAddress: Address, userId: string): Promise<User>

    • Parameters

      • _id: string

      • lastAddress: Address

      • userId: string

      Returns Promise<User>

• updateLastContact: ((_id: string, lastContact: Contact, userId: string) => Promise<User>)

  • • (_id: string, lastContact: Contact, userId: string): Promise<User>

    • Parameters

      • _id: string

      • lastContact: Contact

      • userId: string

      Returns Promise<User>

• updateProfile: ((_id: string, { profile, meta }: { meta?: any; profile?: UserProfile }, userId: string) => Promise<User>)

  • • (_id: string, { profile, meta }: { meta?: any; profile?: UserProfile }, userId: string): Promise<User>

    • Parameters

      • _id: string

      • { profile, meta }: { meta?: any; profile?: UserProfile }

        • Optional meta?: any

        • Optional profile?: UserProfile

      • userId: string

      Returns Promise<User>

• updateRoles: ((_id: string, roles: string[], userId: string) => Promise<User>)

  • • (_id: string, roles: string[], userId: string): Promise<User>

    • Parameters

      • _id: string

      • roles: string[]

      • userId: string

      Returns Promise<User>

• updateTags: ((_id: string, tags: string[], userId: string) => Promise<User>)

  • • (_id: string, tags: string[], userId: string): Promise<User>

    • Parameters

      • _id: string

      • tags: string[]

      • userId: string

      Returns Promise<User>

• updateUser: ((selector: Query, modifier: Update<User>, options: UpdateOptions) => Promise<void>)

  • • (selector: Query, modifier: Update<User>, options: UpdateOptions): Promise<void>

    • Parameters

      • selector: Query

      • modifier: Update<User>

      • options: UpdateOptions

      Returns Promise<void>

• userExists: ((query: { userId: string }) => Promise<boolean>)

  • • (query: { userId: string }): Promise<boolean>

    • Parameters

      • query: { userId: string }

        • userId: string

      Returns Promise<boolean>

• userLocale: ((user: User, params?: { localeContext?: Locale }) => Locale)

  • • (user: User, params?: { localeContext?: Locale }): Locale

    • Parameters

      • user: User

      • Optional params: { localeContext?: Locale }

        • Optional localeContext?: Locale

      Returns Locale