genericrestget

0.0.4 • Public • Published

genericRestGet

With genericRestGet you can get easy data from a REST API

Installation

$ npm install genericrestget

Use

The implementation of this module is very simple:

'use strict';
 
var genericRestGet = require('./lib/app');
 
var options = {
  host: 'http://jsonplaceholder.typicode.com',
  path: '/posts/1'
}
 
genericRestGet(options, function (callback) {
  console.log(callback);
})
 

Options

  • host: A domain name or IP address of the server to issue the request to. Defaults to 'localhost'.
  • path: Request path. Defaults to '/'. Should include query string if any. E.G. '/index.html?page=12'. An exception is thrown when the request path contains illegal characters. Currently, only spaces are rejected but that may change in the future.
  • headers: An object containing request headers.

License

The MIT License (MIT) Copyright (c) 2014-2015 Werbasinnotec.

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.

Readme

Keywords

Package Sidebar

Install

npm i genericrestget

Weekly Downloads

1

Version

0.0.4

License

MIT

Last publish

Collaborators

  • joeherwig
  • mwiesmueller