@surfy/request
v1.1.0
Published
The simplest and lightest Node.js module for sending Post or Get Requests.
Downloads
28
Readme
Request.js
The simplest and lightest Node.js module for sending Post or Get Requests. You can use both HTTPS as well as HTTP for your own purposes.
Installation
npm install @surfy/request
Usage with Node.js
The module will try to convert the received information into JSON. If it fails output Plain Text.
// Import library
import request from "@surfy/request";
/*
Request Options
*/
let options = {
/*
Full requested URL without queries
*/
url: "https://example.com",
/*
Specific Port
If not specified, set based on protocol: https 443, http 80
*/
port: 587,
/*
Request Method
Values: "GET" or "POST"
Default "POST"
*/
method: "GET",
/*
Query params
Object or String
Default {}
*/
params: {
firstParam: "firstValue",
secondParam: "secondValue"
},
/*
Authorization header
Default False
*/
auth: "AUTH_STRING",
/*
Additional Headers
Default False
*/
headers: {
"-x-your-header-param": "Some value",
/*
You can override Content-Type
Default "application/json"
*/
"Content-Type": "application/x-www-form-urlencoded"
}
};
/*
Send Request
Result: JSON or Buffer, but False if error has occurred
*/
let result = await request(options);
MIT License
Alexander Yermolenko • surfy.one
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.