fetch-response-parser
v0.0.2
Published
Properly handle (JSON) responses from the Fetch API
Downloads
3
Readme
Fetch Response Parser
Properly handle (JSON) responses from the Fetch API.
Overview
Handling Fetch API responses can be tedious. To get it right one must:
- Check the response's status
- Check the response's content-type
- Call the proper body retrieval method
- Write promise handlers
And most code doesn't even do it!
Instead of writing (or not writing) this boilerplate over and over you can use the Fetch Response Parser.
Installation
npm install fetch-response-parser
Or
yarn install fetch-response-parser
If you want to load from a script
tag:
<script src="https://cdn.jsdelivr.net/npm/fetch-response-parser@VERSION/dist/fetch-response-parser.min.js"></script>
Where VERSION
is the version number you want to use.
Usage
const parser = require('fetch-response-parser');
fetch('https://httpbin.org/json').
then(parser.json()).
then(json => console.log(slideshow.author)).
catch(error => console.error(error)); // error is an instance of Error
Currently only the json
function is supported.
If you're loading via the script
tag instead of parser
you'd use FetchResponseParser
.
Options
The json
function accepts the following options:
strict
- iftrue
raise an error if the response is successful but the body is not JSON; defaults totrue
Error Handling
When an error occurs an instance of Error
is thrown. This instance has the following additional properties:
json
-Boolean
indicating if the error response was JSONresponseBody
- The response body of the error. Can be anObject
, ifjson
istrue
or aString
if the response was not JSONresponse
- The Fetch APIResponse
redirected
-Boolean
indicating if the response was an HTTP redirectredirectedTo
-String
location of the redirect
Here's an example:
const parser = require('fetch-response-parser');
function handleErorr(error) {
if(error.json)
console.error(error.body.some.property);
else if(error.redirected)
console.error(`Redirected to: ${error.redirectedTo}`)
else
console.error(error.body)
}
fetch('https://httpbin.org/html').
then(parser.json()).
then(json => console.log(json.some.property)).
catch(handleError);
Author
Skye Shaw (skye.shaw -AT- gmail)
License
Released under the MIT License: http://www.opensource.org/licenses/MIT