es6-rest-client
Advanced tools
ES6 JavaScript library aimed to ease communication with HTTP-based RESTful APIs.
The ES6 Rest Client is a JavaScript library aimed to ease up communication with HTTP-based RESTful APIs via an highly semantic, fluent interface that leverages ECMAScript 6 language features such as GlobalFetch, Promise and the meta-programming capabilities of the Proxy object, allowing routes to be specified by simply accessing dynamic properties on the client object itself:
import catalogue from './node_modules/es6-rest-client/dist/client.es6.js';
catalogue.products.books().then(function(stream){
stream.json().then(function(response){
console.log(response);
});
}); // results in: HTTP GET /products/books
yesyesnonpm install es6-rest-client
bower install es6-rest-client
Import the module referenced in the package.json file's jsnext:main field and employ an ES6-aware bundling tool in the build process of your project; a transpiled, UMD version of ES6 Rest Client is however provided in the dist folder for testing purposes.
import restClient from './node_modules/es6-rest-client/dist/client.es6.js';
. . .
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Sample ES6 Rest Client Project</title>
<script src="node_modules/es6-rest-client/dist/client.umd.js"></script>
<script>
'use strict';
const restClient = ES6RestClient.default;
. . .
</script>
</head>
. . .
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Sample ES6 Rest Client Project</title>
<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.22/require.min.js"></script>
<script>
'use strict';
requirejs.config({
baseUrl: 'node_modules',
paths: {
ES6RestClient: 'es6-rest-client/dist/client.umd'
}
});
require(['ES6RestClient'] , function(ES6RestClient) {
const restClient = ES6RestClient.default;
. . .
});
</script>
</head>
. . .
'use strict';
const restClient = require('es6-rest-client')['default'];
. . .
Note: although being written in plain JavaScript, this library adopts the TypeScript interface definition standard to document its features.
| name | chainable | getter returns | description |
|---|---|---|---|
[any] | yes | RestClient | Any property getter invoked on the client instance causes an equally named, slash separated route fragment to be incrementally stored in the current configuration cache. |
Version 3.0.2 introduces public methods keys as computed symbols in order to achieve higher encapsulation; member functions are now accessed by selectively importing and referencing the corresponding entities:
import catalogue, { POST } from './node_modules/es6-rest-client/dist/client.es6.js';
catalogue.products.books[POST](JSON.stringify({ title: "Commodore 64 User's Guide" }));
| name | chainable | description |
|---|---|---|
[SETTINGS](obj?:Object):RestClient | yes | Overrides client instance default settings with user defined values, persisting them in the configuration cache across subsequent calls, unless explicitly either modified or reset. |
[INIT](obj?:RequestInit):RestClient | yes | Allows to pass an initialization object to the underlying GlobalFetch.fetch method call. |
[RESET](settings?:Boolean):RestClient | yes | Restores client to its defaults, except for the settings; passing a truthy value as an argument also reestablishes the latter. |
| name | chainable | description |
|---|---|---|
[GET](params?:Object):Promise<Response> | no | Starts the process of fetching a resource via HTTP GET. Any object passed as argument is serialized into querystring. |
[HEAD](params?:Object):Promise<Response> | no | Starts the process of fetching a resource via HTTP HEAD. Any object passed as argument is serialized into querystring. |
[JSONP](params?:Object):Promise<any> | no | Starts the process of fetching a JSON-encoded resource via JSONP technique. Any object passed as argument is serialized into querystring. |
| `[POST](payload?:Blob | BufferSource | FormData |
| `[PUT](payload?:Blob | BufferSource | FormData |
| `[DELETE](payload?:Blob | BufferSource | FormData |
| `[PATCH](payload?:Blob | BufferSource | FormData |
| `[OPTIONS](payload?:Blob | BufferSource | FormData |
Note: invoking a non-existent method on the ES6 Rest Client causes its name to be parsed as a route fragment and the [GET]() method to be implicitly called with any arguments given in the former (see the example above).
| key | default | description |
|---|---|---|
method?:String | 'GET' | Default HTTP verb; it can be set to one of the following values: 'GET', 'HEAD', 'JSONP', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'. |
baseURI?:String | '/' | Remote resource base URI; it must end with a trailing slash. |
params?:Object | {} | An object whose key/value pairs are serialized to querystring; values can be either primitive types or function expressions. |
jsonp?:Object | { callback: '__es6-rest-client__[[CURRENT_TIMESTAMP]]' } | An object whose first key/value pair allows to respectively specify the jsonP callback querystring parameter name and the chosen function name. |
Note: the term 'Etsy' is a trademark of Etsy, Inc. The following code sample uses the Etsy API but is not endorsed or certified by Etsy, Inc.
~/scripts/helpers/etsyAPIClient.jsimport etsyAPIClient, { SETTINGS } from '../../node_modules/es6-rest-client/dist/client.es6.js';
etsyAPIClient[SETTINGS]({
method: 'JSONP',
baseURI: 'https://openapi.etsy.com/v2/',
params: { fields: 'url,description,url_170x135',
includes: 'Images(url_170x135):1',
api_key: ETSY_API_KEY },
jsonp: { callback: 'jsonpCallback' }
});
export default etsyAPIClient;
~/scripts/app.jsimport Etsy from './helpers/etsyAPIClient.js';
/**
* Enclosing a route fragment into square brackets
* prevents it from being undesirably split into
* separate entities by dot characters
*/
Etsy.listings['active.js']().then((response) => {
console.dir(response.results);
});
~/scripts/helpers/fetchIfExists.jsimport restClient, { SETTINGS, RESET } from '../../node_modules/es6-rest-client/dist/client.es6.js';
function fileExists(fileName, interval){
restClient[SETTINGS]({
method: 'HEAD',
params: { _: function(){ return (new Date()).getTime(); } }
});
return new Promise((resolve) => {
(function checkFile(){
restClient[fileName]().then((response) => {
(response.ok) ? resolve(response) :
setTimeout(checkFile, interval)
});
}());
});
}
function fetchIfExists(fileName, interval){
return fileExists(fileName, interval).then(() => {
return restClient[RESET](true)[fileName]();
});
}
export default fetchIfExists
~/scripts/app.jsimport fetchIfExists from './helpers/fetchIfExists.js';
fetchIfExists('catalogue_01062015.json', 2000).then((stream) => {
stream.json().then((response) => {
console.log(response);
});
});
~/scripts/helpers/bookshelf.jsimport user from '../../node_modules/es6-rest-client/dist/client.es6.js';
/**
* you may want to declare the 'co' library as an external dependency
* in your favourite bundling tool options; rollup reference:
* https://github.com/rollup/rollup/wiki/JavaScript-API#external
*/
import co from 'co';
const bookshelf = co.wrap(function* (){
const sessionResponse = yield user.session();
if (sessionResponse.ok) {
return yield user.bookshelf();
} else {
const localBookshelf = new Blob([localStorage.getItem('bookshelf')],
{type: 'application/json'});
const cachedResponse = new Response(localBookshelf, { status: 200 });
return yield Promise.resolve(cachedResponse);
}
});
export default bookshelf;
~/scripts/app.jsimport bookshelf from './helpers/bookshelf.js';
bookshelf().then(function(stream){
stream.json().then(function(response){
console.dir(response.collection);
});
}, function(error){
console.log(error);
});
~/scripts/helpers/bookshelf.jsimport user from '../../node_modules/es6-rest-client/dist/client.es6.js';
async function bookshelf(){
const sessionResponse = await user.session();
if (sessionResponse.ok) {
return await user.bookshelf();
} else {
const localBookshelf = new Blob([localStorage.getItem('bookshelf')],
{type: 'application/json'});
const cachedResponse = new Response(localBookshelf, { status: 200 });
return Promise.resolve(cachedResponse);
}
}
export default bookshelf;
~/scripts/app.js import bookshelf from './helpers/bookshelf.js';
(async function(){
try {
(await bookshelf()).json().then(function(response){
console.dir(response.collection);
});
} catch (exception) {
console.log(exception);
}
}());
Note: you may want to check the required ES6 features first.
npm install --global gulpnpm installgulp testFAQs
ES6 JavaScript library aimed to ease communication with HTTP-based RESTful APIs.
We found that es6-rest-client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.