Function updateUser

updateUser(connectionOptions: {
    apiUrl: string;
    headers: Object;
}, username: string, updatedUser: {
    display_name?: null | string;
    email?: string;
}): Promise<User>
See
updateUser: https://h.readthedocs.io/en/latest/api-reference/#tag/users/paths/~1users~1{username}/patch

Throws
ApiError
Parameters
- connectionOptions: {
  apiUrl: string;
  headers: Object;
  }
  - apiUrl: string
    
    Target annotation database API URL
  - headers: Object
    
    Headers responsible for authenticating the request and the Hypothes.is Accept header
- username: string
  
  username of the user to update
- updatedUser: {
  display_name?: null | string;
  email?: string;
  }
  
  Updated user
  - Optional display_name?: null | string
  - Optional email?: string
Returns Promise<User>
- Defined in src/api/updateUser.ts:32

Generated using TypeDoc