HttpClient | blitztime

A wrapper around the Blitztime API, in Typescript.

Hierarchy

HttpClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new HttpClient(apiUrl: string): HttpClient

- Defined in src/endpoints.ts:17
Set up the Axios client.

Parameters
- apiUrl: string
Returns HttpClient

Properties

client

client: AxiosInstance

Methods

_request

_request(method: Method, endpoint: string, body?: undefined | Json): Promise<Record<string, any>>

- Defined in src/endpoints.ts:25
Send a request and handle errors in the response.

Parameters
- method: Method
- endpoint: string
- body: undefined | Json = ...
Returns Promise<Record<string, any>>

createTimer

createTimer(settings: StageSettings[], asManager?: boolean): Promise<SocketCredentials>

- Defined in src/endpoints.ts:65
Create a new timer with given settings.

Parameters
- settings: StageSettings[]
- asManager: boolean = false
Returns Promise<SocketCredentials>

getStats

getStats(): Promise<AppStats>

- Defined in src/endpoints.ts:41
Get usage stats for the app.

Returns Promise<AppStats>

getTimer

getTimer(id: number): Promise<Timer>

- Defined in src/endpoints.ts:47
Get information on a timer.

Parameters
- id: number
Returns Promise<Timer>

joinTimer

joinTimer(id: number, side: TimerJoinSide): Promise<SocketCredentials>

- Defined in src/endpoints.ts:53
Join the away side of a timer.

Parameters
- id: number
- side: TimerJoinSide
Returns Promise<SocketCredentials>

Generated using TypeDoc