wonderful-fetch
v1.3.0
Published
A wrapper around fetch.
Downloads
11,192
Readme
🌐 Wonderful Fetch Works in Node AND browser environments
Yes, this module works in both Node and browser environments, including compatibility with Webpack and Browserify!
⚡️ Features
- Intuitive error handling
- Download files directly to drive
🪦 The old way
You have to manually check if the response is ok
and then parse the response as JSON.
fetch('https://httpbin.org/json')
.then((response) => {
if (!response.ok) {
throw new Error('Network response was not ok');
}
return response.json();
})
.then((data) => console.log(data))
.catch((error) => console.error(error));
🦄 The Wonderful Fetch way
With Wonderful Fetch, you can automatically parse the response as JSON and handle all http errors with a single line of code.
wonderfulFetch('https://httpbin.org/json', {response: 'json'})
.then((response) => console.log(response))
.catch((error) => console.error(error));
📦 Install Wonderful Fetch
Option 1: Install via npm
Install with npm if you plan to use wonderful-fetch
in a Node project or in the browser.
npm install wonderful-fetch
If you plan to use wonderful-fetch
in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.
const wonderfulFetch = require('wonderful-fetch');
wonderfulFetch();
Option 2: Install via CDN
Install with CDN if you plan to use Wonderful Fetch only in a browser environment.
<script src="https://cdn.jsdelivr.net/npm/wonderful-fetch@latest/dist/index.min.js"></script>
<script type="text/javascript">
var wonderfulFetch = WonderfulFetch;
wonderfulFetch();
</script>
🚀 Using Wonderful Fetch
After you have followed the install step, you can start using wonderful-fetch
to make requests to any URL
wonderfulFetch(url, options)
Make a request to the supplied url
with options
.
This library returns a Promise
that will resolve if the status code is in the 200
- 299
range and will reject if the status code is outside that range or if the download of the file fails.
options
The options for wonderfulFetch(url, options)
are as follows.
- url
string
: The URL of the resource- Acceptable Values:
any
- Default:
null
- Acceptable Values:
- options
object
: Advanced options- method
string
: The type of request- Acceptable Values:
get
,post
,delete
,put
,patch
- Default:
get
- Acceptable Values:
- response
string
: Automatically format the response- Acceptable Values:
raw
,json
,text
- Default:
raw
- Acceptable Values:
- timeout
number
: The request will automatically timeout after this- Acceptable Values:
any
- Default:
60000
- Acceptable Values:
- tries
number
: The amount of attempts to the URL. Enter-1
for infinity.- Acceptable Values:
any
- Default:
1
- Acceptable Values:
- cacheBreaker
boolean
,any
: Will append?cb={currentTime}
to the URL iftrue
or whatever value you specify.- Acceptable Values:
true
,false
,any
- Default:
true
- Acceptable Values:
- download
string
: Will download the response to this path- Acceptable Values:
any
- Default:
null
- Acceptable Values:
- method
Examples
Basic Fetch
Perform a basic fetch request.
wonderfulFetch('https://httpbin.org/status/200', {method: 'get'})
.then((response) => console.log(response))
.catch((error) => console.error(error));
Basic Fetch JSON
Perform a basic fetch request and return the response as JSON.
wonderfulFetch('https://httpbin.org/status/200', {method: 'get', response: 'json'})
.then((response) => console.log(response))
.catch((error) => console.error(error));
Download File
Download a file to the specified download
path. Node.js only.
wonderfulFetch('https://httpbin.org/image/png', {download: './image.png'})
.then((response) => console.log(response))
.catch((error) => console.error(error));
Handle Errors with catch
Handle errors with the catch
method.
wonderfulFetch('https://httpbin.org/status/404', {method: 'get'})
.then((response) => console.log(response))
.catch((error) => console.error(error));
📚 Extending Capabilities
For a more in-depth documentation of this library and the Wonderful Fetch service, please visit the official Wonderful Fetch website.
❓ What Can Wonderful Fetch do?
Wonderful Fetch is a free fetch api that helps you make requests in Node.js or the browser.
📝 Final Words
If you are still having difficulty, we would love for you to post a question to the Wonderful Fetch issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
🎉 Projects Using this Library
Somiibo: A Social Media Bot with an open-source module library. JekyllUp: A website devoted to sharing the best Jekyll themes. Slapform: A backend processor for your HTML forms on static sites. SoundGrail Music App: A resource for producers, musicians, and DJs. Hammock Report: An API for exploring and listing backyard products.
Ask us to have your project listed! :)