autonym-client v0.1.1

autonym-client

A JavaScript client for consuming Autonym APIs.

A class that provides a thin wrapper around axios for making HTTP requests against an Autonym API.

Installation

npm install autonym-client --save

The 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>

Quick Start

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));

API

Autonym#constructor(uri[, config])

Autonym#create(route, attributes)

Serializes the given attributes and sends a request to create a new resource.

Returns a promise that resolves with the unserialized server response.

Autonym#find(route[, query = {}])

Sends a request to fetch resources, optionally passing a query string to filter the result set.

Returns a promise that resolves with the unserialized server response.

Autonym#findOne(route, id)

Sends a request to fetch a resource.

Returns a promise that resolves with the unserialized server response.

Autonym#findOneAndUpdate(route, id, attributes)

Serializes the given attributes and sends a request to update an existing resource.

Returns a promise that resolves with the unserialized server response.

Autonym#findOneAndDelete(route, id)

Sends a request to delete a resource.

Returns a promise that resolves with the unserialized server response.

Autonym#bindToRoute(route)

A convenience method that returns the methods on this class bound to the given route.

Returns an object with the methods bound to the given route.

Examples

Serializing and unserializing resources

const autonym = new Autonym('https://api.myservice.com', {
  serialize: attributes => ({
    ...attributes,
    birthdate: attributes.birthdate.getTime()
  }),
  unserialize: attributes => ({
    ...attributes,
    birthdate: new Date(attributes.birthdate)
  })
});

Reading and modifying headers

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 };
      }
    }
  }
});