Class ApiXClient

A client for an API-X server.

This object serves as a vanilla client that to reach API-X-based APIs.

Index

Making API-X Requests

createDeleteRequest createGetRequest createPatchRequest createPostRequest createPutRequest createRequest makeDeleteRequest makeGetRequest makePatchRequest makePostRequest makePutRequest makeRequest

Other

constructor

Making API-X Requests

createDeleteRequest

createDeleteRequest(url: URL, data?: ApiXJsonObject): ApiXRequest
Creates a new DELETE request object that can be used to reach an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns ApiXRequest
An ApiXRequest object that can be used to make a request.
- Defined in client/ApiXClient.ts:95

createGetRequest

createGetRequest(url: URL): ApiXRequest
Creates a new GET request object that can be used to reach an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
Returns ApiXRequest
An ApiXRequest object that can be used to make a request.
- Defined in client/ApiXClient.ts:56

createPatchRequest

createPatchRequest(url: URL, data?: ApiXJsonObject): ApiXRequest
Creates a new PATCH request object that can be used to reach an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns ApiXRequest
An ApiXRequest object that can be used to make a request.
- Defined in client/ApiXClient.ts:108

createPostRequest

createPostRequest(url: URL, data?: ApiXJsonObject): ApiXRequest
Creates a new POST request object that can be used to reach an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns ApiXRequest
An ApiXRequest object that can be used to make a request.
- Defined in client/ApiXClient.ts:69

createPutRequest

createPutRequest(url: URL, data?: ApiXJsonObject): ApiXRequest
Creates a new PUT request object that can be used to reach an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns ApiXRequest
An ApiXRequest object that can be used to make a request.
- Defined in client/ApiXClient.ts:82

createRequest

createRequest(
    url: URL,
    httpMethod?: ApiXHttpMethod,
    data?: ApiXJsonObject,
): ApiXRequest
Creates a new request object that can be used to reach an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- httpMethod: ApiXHttpMethod = 'GET'
  The HTTP Method to use.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns ApiXRequest
An ApiXRequest object that can be used to make a request.
- Defined in client/ApiXClient.ts:35

makeDeleteRequest

makeDeleteRequest(
url: URL,
data?: ApiXJsonObject,
): Promise<ApiXResponse<ApiXResponseData>>
Makes a DELETE request to an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns Promise<ApiXResponse<ApiXResponseData>>
An ApiXRequest object that can be used to make a request.

Throws
May throw errors that need to be caught.
- Defined in client/ApiXClient.ts:178

makeGetRequest

makeGetRequest(url: URL): Promise<ApiXResponse<ApiXResponseData>>
Makes a GET request to an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
Returns Promise<ApiXResponse<ApiXResponseData>>
An ApiXRequest object that can be used to make a request.

Throws
May throw errors that need to be caught.
- Defined in client/ApiXClient.ts:139

makePatchRequest

makePatchRequest(
url: URL,
data?: ApiXJsonObject,
): Promise<ApiXResponse<ApiXResponseData>>
Makes a PATCH request to an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns Promise<ApiXResponse<ApiXResponseData>>
An ApiXRequest object that can be used to make a request.

Throws
May throw errors that need to be caught.
- Defined in client/ApiXClient.ts:191

makePostRequest

makePostRequest(
url: URL,
data?: ApiXJsonObject,
): Promise<ApiXResponse<ApiXResponseData>>
Makes a POST request to an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns Promise<ApiXResponse<ApiXResponseData>>
An ApiXRequest object that can be used to make a request.

Throws
May throw errors that need to be caught.
- Defined in client/ApiXClient.ts:152

makePutRequest

makePutRequest(
url: URL,
data?: ApiXJsonObject,
): Promise<ApiXResponse<ApiXResponseData>>
Makes a PUT request to an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns Promise<ApiXResponse<ApiXResponseData>>
An ApiXRequest object that can be used to make a request.

Throws
May throw errors that need to be caught.
- Defined in client/ApiXClient.ts:165

makeRequest

makeRequest(
    url: URL,
    httpMethod?: ApiXHttpMethod,
    data?: ApiXJsonObject,
): Promise<ApiXResponse<ApiXResponseData>>
Makes a request to an API-X-based API.
Parameters
- url: URL
  The URL of the API-X endpoint.
- httpMethod: ApiXHttpMethod = 'GET'
  The HTTP Method to use.
- Optionaldata: ApiXJsonObject
  The request JSON Body, if any.
Returns Promise<ApiXResponse<ApiXResponseData>>
An ApiXRequest object that can be used to make a request.

Throws
May throw errors that need to be caught.
- Defined in client/ApiXClient.ts:123

Other

constructor

new ApiXClient(keyStore: ApiXKeyStore): ApiXClient
Creates a new instance of an API-X Client.
Parameters
- keyStore: ApiXKeyStore
  An object that securely retrieves API keys.
Returns ApiXClient
- Defined in client/ApiXClient.ts:20

Class ApiXClient

Index

Making API-X Requests

Other

Making API-X Requests

createDeleteRequest

Parameters

Returns ApiXRequest

createGetRequest

Parameters

Returns ApiXRequest

createPatchRequest

Parameters

Returns ApiXRequest

createPostRequest

Parameters

Returns ApiXRequest

createPutRequest

Parameters

Returns ApiXRequest

createRequest

Parameters

Returns ApiXRequest

makeDeleteRequest

Parameters

Returns Promise<ApiXResponse<ApiXResponseData>>

Throws

makeGetRequest

Parameters

Returns Promise<ApiXResponse<ApiXResponseData>>

Throws

makePatchRequest

Parameters

Returns Promise<ApiXResponse<ApiXResponseData>>

Throws

makePostRequest

Parameters

Returns Promise<ApiXResponse<ApiXResponseData>>

Throws

makePutRequest

Parameters

Returns Promise<ApiXResponse<ApiXResponseData>>

Throws

makeRequest

Parameters

Returns Promise<ApiXResponse<ApiXResponseData>>

Throws

Other

constructor

Parameters

Returns ApiXClient

Settings

On This Page