A JavaScript client for consuming Autonym APIs.
A class that provides a thin wrapper around axios for making HTTP requests against an Autonym API.
npm install autonym-client --saveThe package can be imported into your application if you are using a build system like Webpack or Browserify.
// es2015
import Autonym from 'autonym-client';
// common-js
const Autonym = require('autonym-client');Alternatively, you can point a script tag to the dist file. Note that the dist file bundles its dependencies, axios and qs.
<!-- uncompressed -->
<script src="/node_modules/autonym-client/dist/autonym.js"></script>
<!-- compressed -->
<script src="/node_modules/autonym-client/dist/autonym.min.js"></script>const autonym = new Autonym('https://api.myservice.com');
const peopleApi = autonym.bindToRoute('people');
// Create a new resource
peopleApi.create({ firstName: 'John', lastName: 'Galt' }).then(response => console.log(response));
// Fetch resources
peopleApi.find().then(response => console.log(response));
// Fetch a resource
peopleApi.findOne('42').then(response => console.log(response));
// Update an existing resource
peopleApi.findOneAndUpdate('42', { lastName: 'Doe' }).then(response => console.log(response));
// Delete a resource
peopleApi.findOneAndDelete('42').then(response => console.log(response));| Argument | Type | Description | Default Value |
|---|---|---|---|
uri |
string |
The URI to your Autonym server. | None |
config |
object |
{} |
|
config.serialize |
function(attributes) |
A function to transform resource attributes before sending it. | None |
config.unserialize |
function(attributes) |
A function to transform resource attributes received. | None |
config.axiosConfig |
object |
Additional configuration to pass to the axios instance. | {} |
Serializes the given attributes and sends a request to create a new resource.
| Argument | Type | Description | Default Value |
|---|---|---|---|
route |
string |
The route for the resource. | None |
attributes |
object |
The attributes of the resource. | None |
Returns a promise that resolves with the unserialized server response.
Sends a request to fetch resources, optionally passing a query string to filter the result set.
| Argument | Type | Description | Default Value |
|---|---|---|---|
route |
string |
The route for the resource. | None |
query |
object |
An object that will be converted to a query string via qs.stringify() and appended. |
{} |
Returns a promise that resolves with the unserialized server response.
Sends a request to fetch a resource.
| Argument | Type | Description | Default Value |
|---|---|---|---|
route |
string |
The route for the resource. | None |
id |
string |
The id that uniquely identifies the resource to get. | None |
Returns a promise that resolves with the unserialized server response.
Serializes the given attributes and sends a request to update an existing resource.
| Argument | Type | Description | Default Value |
|---|---|---|---|
route |
string |
The route for the resource. | None |
id |
string |
The id that uniquely identifies the resource to update. | None |
attributes |
object |
The attributes to update. | None |
Returns a promise that resolves with the unserialized server response.
Sends a request to delete a resource.
| Argument | Type | Description | Default Value |
|---|---|---|---|
route |
string |
The route for the resource. | None |
id |
string |
The id that uniquely identifies the resource to delete. | None |
Returns a promise that resolves with the unserialized server response.
A convenience method that returns the methods on this class bound to the given route.
| Argument | Type | Description | Default Value |
|---|---|---|---|
route |
string |
The route to bind the methods to. | None |
Returns an object with the methods bound to the given route.
const autonym = new Autonym('https://api.myservice.com', {
serialize: attributes => ({
...attributes,
birthdate: attributes.birthdate.getTime()
}),
unserialize: attributes => ({
...attributes,
birthdate: new Date(attributes.birthdate)
})
});const autonym = new Autonym('https://api.myservice.com', {
axiosConfig: {
transformRequest: (data, headers) => {
headers['Authorization'] = `Token ${localStorage.getItem('apiToken')}`;
return data;
},
transformResponse: (data, headers) => {
if (Array.isArray(data)) {
return { items: data, numberOfPages: parseInt(headers['x-page-count'], 10) };
} else {
return { item: data };
}
}
}
});