Class HttpClient

Hierarchy

HttpClient

Index

Constructors

constructor

Methods

Constructors

constructor

new HttpClient(config: SpotifyConfig, privateConfig: PrivateConfig): HttpClient

- Defined in src/lib/http/HttpManager.ts:26
Parameters
- config: SpotifyConfig
- privateConfig: PrivateConfig
Returns HttpClient

Methods

delete

delete(slug: string, data: any, options?: { query?: Record<string, string> } & AxiosRequestConfig<any>): Promise<AxiosResponse<any, any>>

- Defined in src/lib/http/HttpManager.ts:391
Parameters
- slug: string
  The slug to delete.
- data: any
  Body data.
- Optional options: { query?: Record<string, string> } & AxiosRequestConfig<any>
  Options.
Returns Promise<AxiosResponse<any, any>>
Returns a promise with the response.

get

get(slug: string, options?: { query?: Record<string, string> } & AxiosRequestConfig<any>): Promise<AxiosResponse<any, any>>

- Defined in src/lib/http/HttpManager.ts:350
Parameters
- slug: string
  The slug to get.
- Optional options: { query?: Record<string, string> } & AxiosRequestConfig<any>
  Options.
Returns Promise<AxiosResponse<any, any>>
Returns a promise with the response.

getURL

getURL(slug: string, query?: Record<string, string>): string

- Defined in src/lib/http/HttpManager.ts:33
Parameters
- slug: string
- Optional query: Record<string, string>
Returns string
Returns the full url.

post

post(slug: string, data: any, config?: { query?: Record<string, string> } & AxiosRequestConfig<any>): Promise<AxiosResponse<any, any>>

- Defined in src/lib/http/HttpManager.ts:363
Parameters
- slug: string
  The slug to post.
- data: any
  Body data.
- Optional config: { query?: Record<string, string> } & AxiosRequestConfig<any>
  Config.
Returns Promise<AxiosResponse<any, any>>
Returns a promise with the response.

put

put(slug: string, data: any, config?: { query?: Record<string, string> } & AxiosRequestConfig<any>): Promise<AxiosResponse<any, any>>

- Defined in src/lib/http/HttpManager.ts:377
Parameters
- slug: string
  The slug to put.
- data: any
  Body data.
- Optional config: { query?: Record<string, string> } & AxiosRequestConfig<any>
  Config.
Returns Promise<AxiosResponse<any, any>>
Returns a promise with the response.

Generated using TypeDoc