README.md

hal-resource

REST+HAL client for Browser and NodeJS

Getting Started

Installation

$ npm install --save @redneckz/hal-resource

$ yarn add @redneckz/hal-resource

Basics

import { HALResource } from '@redneckz/hal-resource';

const resource = HALResource(window.fetch); // Axios can be used for NodeJS

const customersResource = resource('https://foo.com/api/v1/customers');

const sortedCustomers = customersResource.getList({ sort: { field: 'name', order: 'ASC' } });
sortedCustomers.then(console.log);

const firstCustomer = customersResource.getOne('first-customer-id');
firstCustomer.then(console.log);

const newCustomer = customersResource.create({ name: 'New Customer' });
newCustomer.then(console.log);

customersResource.delete('first-customer-id');

License

MIT