Resolver cache implementing Web Storage API.
Shared Consola instance.
Custom Fetch API implementation for making authenticated requests.
Custom Fetch API implementation for making authenticated requests.
Path to this resource node as base URL followed by a list of curies.
Bookmark URL for this API. This is where the tree traversal begins. We also use this URL as a base for relative paths.
Resolver cache implementing Web Storage API.
Every resolved path will be stored here for future use. You can clear this cache by calling clear().
Consola instance. If you extend this class and add logging in your code, use this instead of native console.
Credentials storage implementing Web Storage API. Access tokens and other related info will be stored here. Clearing this storage will log you out.
Polyfilled version of the built-in Headers class. If you need to pass an instance of Headers to .fetch(),
use this class instead of the built-in one to avoid this issue.
Polyfilled version of the built-in Request class. If you need to pass an instance of Request to .fetch(),
use this class instead of the built-in one to avoid this issue.
Polyfilled version of the built-in Response class. If you need to check the return value of .fetch(),
use this class instead of the built-in one to avoid this issue.
Polyfilled version of the built-in fetch function. If you need to call fetch() with poyfilled request, response or headers,
use this function instead of the built-in one to avoid this issue.
Makes a raw and, if possible, authenticated request to the API. This method implements native Fetch API.
Fetch API arguments (url and request parameters).
Fetch API response.
Resource path builder. Calling this method instructs our SDK to find the provided curie in this resource's links and navigate to its location on request.
Curie to follow.
Instance of {@link APINode} representing the resource at curie location.
Resolves the URL of this node and sends a GET request using provided parameters.
Instance of {@link APIResponse} representing this resource.
Resolves the URL of this node and sends a GET request using provided parameters.
Query parameters such as zoom, fields etc.
Instance of {@link APIResponse} representing this resource.
Resolves the URL of this node and sends a POST request with provided properties, creating a resource or triggering an action.
Complete resource object.
A small, human readable explanation of this resource.
Instance of {@link APIResponse} representing this resource.
Resolves the URL of this node and sends a PUT request with provided properties, replacing the existing resource.
Complete resource object.
A small, human readable explanation of this resource.
Instance of {@link APIResponse} representing this resource.
Fetches a new access token in exchange for an authorization code or a refresh token. See more in our authentication docs.
Request options.
Access token with additional info on success, null on failure.
Generated using TypeDoc
JS SDK for building backends with Foxy Hypermedia API. Hypermedia API is designed to give you complete control over all aspects of your Foxy accounts, whether working with a single store or automating the provisioning of thousands. Anything you can do within the Foxy administration, you can also do through the API. This means that you can embed Foxy into any application (CMS, LMS, CRM, etc.) and expose as much or as little of Foxy's functionality as desired.