Upload main code

This commit is contained in:
2019-01-12 15:17:13 +01:00
committed by GitHub
parent 84507a8d6b
commit a03320593f
7 changed files with 247 additions and 2 deletions

71
README.md Normal file
View File

@@ -0,0 +1,71 @@
# Wumpfetch
> A lightweight and fast Node.js HTTP client which can be used in various ways
> [GitHub](https://www.github.com/PassTheWessel/wumpfetch) **|** [NPM](https://www.npmjs.com/package/wumpfetch)
## Installing
```sh
$ yarn add wumpfetch # Install w/ Yarn (the superior package manager)
$ npm i wumpfetch # Install w/ NPM
```
## Usage
##### Code
```js
const w = require( 'wumpfetch' );
;( async() => {
const r = await w( 'https://aws.random.cat/meow' ).send();
console.log( r.json() );
});
```
##### Result
```sh
$ node test.js
{ file: 'https://purr.objects-us-east-1.dream.io/i/100_-_rURSo7L.gif' }
```
### Sending data in a JSON body to a server
```js
const w = require( 'wumpfetch' );
;( async() => {
const r = await w( 'https://my-site.com/postboi', 'POST' )
.query( 'video', 'wumpboye' ) // Add a query
.header({ 'Authorization': 'Pablito' }) // Set a header
.post({ x: 'y', z: 1, beep: 'boop', chocolate: true }) // Send a json body
.timeout( 1000 ) // Set a 1s timeout
.send();
console.log( r.json() );
})();
```
or
```js
const w = require( 'wumpfetch' );
;( async() => {
const r = await w({
url: 'https://my-site.com/postboi',
method: 'GET',
headers: {
'Authorization': 'Pablo'
}
});
console.log( r.json() );
})();
```
or
```js
const w = require( 'wumpfetch' );
;( async() => {
const r = await w( 'https://my-site.com/postboi', { method: 'GET' });
console.log( r.json() );
})();
```
### Why should i use wumpfetch?
Wumpfetch is a lightweight and fast request library comparing to other packages such as request and node-fetch which are both around 150kb in size