restify-rest-client
v4.0.1
Published
Restify REST client
Downloads
55
Readme
restify-rest-client
Yet another REST client based on Restify.
Install
npm install restify-rest-client
Examples
'use strict';
const RestClient = require('restify-rest-client');
const options = {
restify: {
url: 'https://api.example.org'
}
};
const restClient = new RestClient(options);
// node callback style
restClient.get('/users/100/groups', (err, req, res, body) => {
if (err) {
return console.error(err);
}
console.log('body: %s', JSON.stringify(body));
});
// or using promise
restClient.get('/users/100/groups').then((result) => {
console.log('req:', result[0]);
console.log('res:', result[1]);
console.log('body: %s', JSON.stringify(result[2]));
});
// using promise-spread or bluebird packages
restClient.get('/users/100/groups').spread((req, res, body) => {
console.log('body: %s', JSON.stringify(body));
});
You can refer to other examples as a starting point for your web applications.
Options
- options
- restify - the restify json client options. Read more here
- credentialsProvider - the credentials provider instance. Default:
new DefaultCredentialsProvider()
License
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.