BaseClient | polympics

Base class for clients.

Hierarchy

BaseClient
- UnauthenticatedClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseClient(__namedParameters?: { apiUrl?: string; credentials?: null | Credentials }): BaseClient

- Defined in polympics/client.ts:26
Parameters
- __namedParameters: { apiUrl?: string; credentials?: null | Credentials } = ...
  - Optional apiUrl?: string
  - Optional credentials?: null | Credentials
Returns BaseClient

Properties

apiUrl

apiUrl: string

Optional credentials

credentials: null | Credentials

Methods

Private handleResponse

handleResponse<Type>(response: Response, emptyResponse?: boolean): Promise<Type>

- Defined in polympics/client.ts:37
Handle a response from the API, raising possible errors.

Type parameters
- Type
Parameters
- response: Response
- emptyResponse: boolean = false
Returns Promise<Type>

Protected request

request<Type>(method: HttpMethod, endpoint: string, data?: Record<string, any>, __namedParameters?: { emptyResponse?: boolean }): Promise<Type>

- Defined in polympics/client.ts:57
Make a request to an API endpoint.

Type parameters
- Type
Parameters
- method: HttpMethod
- endpoint: string
- data: Record<string, any> = ...
- __namedParameters: { emptyResponse?: boolean } = ...
  - Optional emptyResponse?: boolean
Returns Promise<Type>

Generated using TypeDoc