Documentation

Global

Type Definitions

ClientOptions

The options for the base client
Type:
  • Object
Properties:
Name Type Description
apiURL String

RequestOptions

The options for a request
Type:
  • Object
Properties:
Name Type Argument Description
url String The API endpoint to request.
method String <optional>
 The HTTP method to use, e.g. GET, POST. Defaults to 'GET'.
authenticated Boolean <optional>
 true if requesting an authenticated endpoint. Defaults to false.
data Object <optional>
 The request body for the request, if needed.