archives/wumpfetch
1
0
Fork 0
mirror of https://github.com/Wessel/wumpfetch.git synced 2026-07-21 23:57:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Wessel Tip
2019-04-12 20:00:12 +02:00
parent 4dac543971
commit 3bfa5e90d7
3 changed files with 3 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -8,105 +8,18 @@
Wumpfetch is a fast, lightweight and easy to use HTTP client for Node.JS.
> [`Typings`](https://github.com/PassTheWessel/wumpfetch-typings) **|** [`GitHub`](https://github.com/PassTheWessel/wumpfetch) **|** [`NPM`](https://npmjs.com/package/wumpfetch)
> [`GitHub`](https://github.com/PassTheWessel/wumpfetch) **|** [`NPM`](https://npmjs.com/package/wumpfetch)
<br>
## Installing
Wumpfetch can be installed with any package manager that supports the NPM registry, but the ones listed below are the most used ones.
```sh
$ yarn add wumpfetch # Install w/ Yarn
$ npm i wumpfetch # Install w/ NPM
```
## Example 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
#### Getting a response from a REST API
**Code**:
```js
const w = require('wumpfetch');
// Using an URL and custom options
;(async() => {
let req = await w('https://aws.random.cat/meow', {
chaining: false,
headers: {
'User-Agent': 'Project/0.0.1'
}
});
// Only URL
req = await w('https://aws.random.cat/meow', { chaining: false });
// Only options
req = await w({
url: 'https://aws.random.cat/meow',
chaining: false,
headers: {
'User-Agent': 'Project/0.0.1'
}
});
console.log(req.json());
})();
```
**Result**:
```sh
$ node test.js
{ file: 'https://purr.objects-us-east-1.dream.io/i/100_-_rURSo7L.gif' }
```
#### Chaining methods
You can also chain methods by adding `chaining: true` to `options`
```js
const w = require('wumpfetch');
;(async() => {
const r = await w('https://my-site.com/postboi', { method: 'POST' })
.timeout(1000) // Set a 1s timeout
.query('video', 'wumpboye') // Add a query
.header({ 'Authorization': 'Pablito' }) // Set a header
.body({ x: 'y', z: 1, beep: 'boop', chocolate: true }) // Send a JSON body
.send(); // Finish the chain by sending the rquest
console.log(r.json()); // Returns the response in a JSON format
})();
```
## Projects using Wumpfetch
> If you want your own project listed, either create a pull request or an issue with the following content:
> * Project name
> * a **short** description of your package
>
> Also add the following if your project is a package/module/library:
> * NPM link (🔩)
> * Packagephobia link (⚖)
> * GitHub repository link (📂)
> * *Optional*: A website link (👾)
| Project Name | Short description | Links
|----------|----------|:-------------:
| boats.js | The official discord.boats API wrapper for NodeJS | [🔩](https://npmjs.com/package/boats.js) [⚖](https://packagephobia.now.sh/result?p=boats.js) [📂](https://github.com/DiscordBoats/boats.js) [👾](https://boats.js.org/?referrer=wumpfetch)
| qtradio.js | API wrapper for qtradio.moe made in JavaScript | [🔩](https://npmjs.com/package/qtradio.js) [⚖](https://packagephobia.now.sh/result?p=qtradio.js) [📂](https://github.com/auguwu/qtradio.js) [👾](https://qtradio.moe/?referrer=wumpfetch)
| cafebot.js | CafeBot.xyz API Wrapper made in JS | [🔩](https://npmjs.com/package/cafebot.js) [⚖](https://packagephobia.now.sh/result?p=cafebot.js) [📂](https://github.com/DopeDealers/cafebot.js) [👾](https://cafebot.xyz/?referrer=wumpfetch)
## Documentation
Documentation can be found at [https://github.com/PassTheWessel/wumpfetch/wiki](https://github.com/PassTheWessel/wumpfetch/wiki)
## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FPassTheWessel%2Fwumpfetch.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FPassTheWessel%2Fwumpfetch?ref=badge_large)