Skip to main content

Function: getUser()

getUser(client, props): Promise<{ id: number; name: string; }>

Gets user information by username.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ userName: string; } = getUserParamsSchema

Path parameters (userName)

params.userName​

string = userNameSchema

Returns​

Promise<{ id: number; name: string; }>

Promise resolving to the user information

Operation Id​

get-user

Example​

const user = await getUser(client, {
  params: { userName: 'john-doe' }
});