API

Index

Constructors

constructor

Methods

Constructors

constructor()

Signature

new API(config: null | Config | InternalConfig): API;

Parameters

Name	Type
`config`	`null` \| `Config` \| `InternalConfig`

Returns

API

Defined in: src/Api/lib/ApiV3.ts:105

Methods

errorForCode()

Signature

errorForCode(code: ErrorCode): HttpError;

Parameters

Name	Type
`code`	`ErrorCode`

Returns

HttpError

Defined in: src/Api/lib/ApiV3.ts:121

get()

Signature

get<T>(path: string): Promise<HttpResponse<T>>;

Type parameters

T extends V3Response

Parameters

Name	Type
`path`	`string`

Returns

Promise<HttpResponse<T>>

Defined in: src/Api/lib/ApiV3.ts:125

getContext()

Signature

getContext(): undefined | AppContext;

Returns

undefined | AppContext

Defined in: src/Api/lib/ApiV3.ts:225

post()

Signature

post<T>(path: string, payload: Payload): Promise<HttpResponse<T>>;

Type parameters

T extends V3Response

Parameters

Name	Type
`path`	`string`
`payload`	`Payload`

Returns

Promise<HttpResponse<T>>

Defined in: src/Api/lib/ApiV3.ts:129

request()

Signature

request<T>(
  method: HttpMethod,
  path: string,
  payload: undefined | Payload,
  options: RequestOptions = ...): Promise<HttpResponse<T>>;

Type parameters

T extends V3Response

Parameters

Name	Type
`method`	`HttpMethod`
`path`	`string`
`payload`	`undefined` \| `Payload`
`options`	`RequestOptions`

Returns

Promise<HttpResponse<T>>

Defined in: src/Api/lib/ApiV3.ts:133