Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keithwhor/io
A simple Node.js HTTP wrapper for API calls
https://github.com/keithwhor/io
Last synced: 5 days ago
JSON representation
A simple Node.js HTTP wrapper for API calls
- Host: GitHub
- URL: https://github.com/keithwhor/io
- Owner: keithwhor
- License: mit
- Created: 2024-04-26T07:22:12.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-08-18T04:40:09.000Z (3 months ago)
- Last Synced: 2024-08-18T05:33:42.943Z (3 months ago)
- Language: JavaScript
- Size: 116 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# io
**io** is a simple Node.js HTTP wrapper for API calls.
Methods supported are...
```javascript
const io = require('io');
io.request(method, url, queryParams = {}, headers = null, body = null);
io.get(url, authorization = null, headers = null, queryParams = {});
io.del(url, authorization = null, headers = null, queryParams = {});
io.post(url, authorization = null, headers = null, params = {});
io.put(url, authorization = null, headers = null, params = {});
```
All requests return a `Promise` and can be run synchronously using `await`.
```javascript
let result = await io.request(method, url, queryParams = {}, headers = null, body = null);
```
## request
The `request` method takes a raw `body` string and sends no `content-type` by default.
It returns a result with the following schema;
```json
{
"statusCode": 200,
"headers": {},
"body": ""
}
```
## get, del
The `get` and `del` methods will populate the URL querystring with `x-www-urlencoded`
values based on a `queryParams` object. They will send a
`content-type: application/json` header by default.
The `authorization` parameter will set the `authorization` HTTP header. If this
value begins with the strings `Basic ` or `Bearer `, the full value will be used.
Otherwise, `Bearer ` will be prepended. Sending `authorization = "x"`, for example,
will populate the `authorization` header with a value of `Bearer x`.
**NOTE:** If the requested resource does not return JSON data, an error will be thrown.
They return a result with the following schema;
```json
{
"statusCode": 200,
"headers": {},
"data": {}
}
```
## post, put
The `post` and `put` methods will populate the post body with `application/json`
values based on a `params` object. They will send a
`content-type: application/json` header by default.
The `authorization` parameter will set the `authorization` HTTP header. If this
value begins with the strings `Basic ` or `Bearer `, the full value will be used.
Otherwise, `Bearer ` will be prepended. Sending `authorization = "x"`, for example,
will populate the `authorization` header with a value of `Bearer x`.
**NOTE:** If the requested resource does not return JSON data, an error will be thrown.
They return a result with the following schema;
```json
{
"statusCode": 200,
"headers": {},
"data": {}
}
```
# Thanks!
© 2020 Standard Library (Polybit Inc.)