shared/apiClient

Classes

APIClient

Type Definitions

APIClientEndpoint

Source:
Properties:
Name Type Attributes Description
path string

The path to the endpoint relative to the API entry point. It can include placeholders with the format :placeholder-name that are going to be replaced when the endpoint gets generated.
query APIClientParametersDictionary <nullable>

A dictionary of query string parameters that will be added when the endpoint. If the value of a parameter is null, it won't be added.
Type:

APIClientEndpoints

Source:
Type:
Example
{ // Endpoint path as a string.
endpointOne: 'endpoint-one',
// Endpoint as {APIClientEndpoint}.
endpointTwo: {
path: 'endpoint-two',
query: {
count: 20,
},
},
// Endpoint as a dictionary of endpoints ({APIClientEndpoints}).
endpointThree: {
subEndpointThreeOne: 'sub-endpoint-three-one',
subEndpointThreeTwo: {
path: 'sub-endpoint-three-two',
query: {
count: 20,
},
},
},
}

APIClientEndpointValue

Source:
Type:

APIClientFetchClient(url, optionsopt) → {Promise.<Response>}

Source:
See:
Parameters:
Name Type Attributes Description
url string

The request URL.
options APIClientFetchOptions <optional>

The request options.
Returns:
Type
Promise.<Response>

APIClientFetchOptions

Source:
Properties:
Name Type Attributes Description
method string <optional>

The request method.
headers APIClientParametersDictionary <optional>

The request headers.
body string <optional>

The request body.
json boolean <optional>

Whether or not the response should "JSON decoded".
Type:

APIClientParametersDictionary

Source:

This kind of dictionary is used for building stuff like query string parameters and headers.

Type:

APIClientRequestOptions

Source:
Type:

APIClientRequestOptionsProperties

Source:
Properties:
Name Type Description
url string

The request URL.
Type: