Class User

constructor

• new User(schem: UserSchema): User

• Parameters

  • schem: UserSchema

  Returns User

groups

id

roles

username

version

Static get

• get(id: string): Promise<User>

• Retrieves a user by their id

  Parameters

  • id: string

  Returns Promise<User>

Static getByQuery

• getByQuery(query?: Partial<Merge<GetUserParamsSchema, {
      ids: User[];
  }>>): Promise<null | User>

• Performs a search for a user and returns the first one found. If no results are found, null is returned

  Parameters

  • Optional query: Partial<Merge<GetUserParamsSchema, {
        ids: User[];
    }>>

  Returns Promise<null | User>

Static getFollowedUsers

• getFollowedUsers(query?: RequestQuery): Promise<User[]>

• Returns all users followed by the currently authenticated user.

  Parameters

  • query: RequestQuery = ...

  Returns Promise<User[]>

Static getLoggedInUser

• getLoggedInUser(): Promise<User>

• Returns a user object for the currently authenticated user.

  Returns Promise<User>

Static getMultiple

• getMultiple(ids: string[]): Promise<User[]>

• Retrieves an array of users by an array of ids

  Parameters

  • ids: string[]

  Returns Promise<User[]>

Static search

• search(query?: Partial<Merge<GetUserParamsSchema, {
      ids: User[];
  }>>): Promise<User[]>

• Retrieves a list of users according to the specified search parameters

  Parameters

  • Optional query: Partial<Merge<GetUserParamsSchema, {
        ids: User[];
    }>>

  Returns Promise<User[]>