Class User

constructor

• new User(schem: UserSchema): User

  Parameters

  • schem: UserSchema

  Returns User

groups

id

roles

username

version

Staticget

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

  Retrieves a user by their id

  Parameters

  • id: string

  Returns Promise<User>

StaticgetByQuery

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

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

  Parameters

  • Optionalquery: Partial<Merge<GetUserParamsSchema, { ids: User[] }>>

  Returns Promise<User | null>

StaticgetFollowedUsers

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

  Returns all users followed by the currently authenticated user.

  Parameters

  • query: RequestQuery = ...

  Returns Promise<User[]>

StaticgetLoggedInUser

• getLoggedInUser(): Promise<User>

  Returns a user object for the currently authenticated user.

  Returns Promise<User>

StaticgetMultiple

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

  Retrieves an array of users by an array of ids

  Parameters

  • ids: string[]

  Returns Promise<User[]>

Staticsearch

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

  Retrieves a list of users according to the specified search parameters

  Parameters

  • Optionalquery: Partial<Merge<GetUserParamsSchema, { ids: User[] }>>

  Returns Promise<User[]>