Class UserFunctions

User-related functions. Corresponds to the /user API route.

Hierarchy

UserFunctions

Index

Constructors

constructor

Properties

#axios

Methods

Constructors

constructor

new UserFunctions(axios: ClientAxios): UserFunctions

- Defined in classes/UserFunctions.ts:13
Intended to be instantiated internally by Client.

Parameters
- axios: ClientAxios
Returns UserFunctions

Properties

Private #axios

#axios: ClientAxios

Methods

favorite

favorite(url: string): Promise<FavoriteURL>

- Defined in classes/UserFunctions.ts:46
Add to current user's favorite URLs.

Parameters
- url: string
Returns Promise<FavoriteURL>

favorites

favorites(): Promise<UserFavoritesResponse>

- Defined in classes/UserFunctions.ts:40
Get current user's favorite URLs.

Returns Promise<UserFavoritesResponse>

query

query(username: string): Promise<UserQueryResponse>

- Defined in classes/UserFunctions.ts:34
Get information about a user given their username.

Parameters
- username: string
Returns Promise<UserQueryResponse>

register

register(username: string, email: string, password: string): Promise<User>

- Defined in classes/UserFunctions.ts:23
Create a new user account.

Parameters
- username: string
- email: string
- password: string
Returns Promise<User>

unfavorite

unfavorite(favoriteId: string): Promise<GenericSuccess>

- Defined in classes/UserFunctions.ts:54
Delete from current user's favorite URLs

Parameters
- favoriteId: string
Returns Promise<GenericSuccess>

Static instantiate

instantiate(axios: ClientAxios): UserFunctions

- Defined in classes/UserFunctions.ts:18
Create an instance of this class. Intended for internal use by Client

Parameters
- axios: ClientAxios
Returns UserFunctions

Generated using TypeDoc