getUser

Type: getUser(username: string): Promise<APIResult<userInfoProps>>

getUser() retrieves profile information (such as ID, avatar, join date, etc.) for the specified Scratch username via the Scratch API.

const sab = sauthbase.use();
const userInfo = await sab.getUser("griffpatch");

Parameters

Return Value

• Promise<APIResult<userInfoProps>>: On success, the profile information is returned in the data field. On failure, an error response is returned.

Example Usage

const userInfo = await sauthbase.use().getUser("scratchteam");
 
if (userInfo.success) {
  console.log(userInfo.data); // Scratch user profile information
} else {
  console.error(userInfo.message);
}

Notes

• If the specified user does not exist or the Scratch API does not respond, the result will have success: false.
• The returned data depends on the Scratch API specification.