Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/realmteam/easyfetch
Simple wrapper around fetch with json support
https://github.com/realmteam/easyfetch
fetch fetch-api javascript js wrapper
Last synced: 2 months ago
JSON representation
Simple wrapper around fetch with json support
- Host: GitHub
- URL: https://github.com/realmteam/easyfetch
- Owner: RealmTeam
- License: mit
- Created: 2017-04-06T10:46:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T08:37:58.000Z (8 months ago)
- Last Synced: 2024-10-12T20:11:55.162Z (3 months ago)
- Topics: fetch, fetch-api, javascript, js, wrapper
- Language: JavaScript
- Size: 138 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# easyfetch
[](https://www.npmjs.com/package/easyfetch)
`easyfetch` is a simple package that aims to facilitate the use of the default fetch function by wrapping it inside an easy to use api.
It uses [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) to support node.js and non-compatible browsers.
# Getting started
## Install
```sh
$ npm install --save easyfetch
```
or
```sh
$ yarn add easyfetch
```
## Api
### `easyFetch(url)`
It returns the `EasyFetch` class instance.
### `jsonFetch(url)`
It returns the `JsonFetch` class instance.
It also adds `Accept` and `Content-Type` headers to : `application/json` and automatically calls `.json()` on the response object returned by the promise.
### `setHeaders(headers)`
Set headers on the request.
`headers` is an object.
It returns the `EasyFetch` or `JsonFetch` class instance in order to chain calls.
*Should be called before `_fetch`.*
### `setQueryParams(queryParams)`
Set query parameters on the url.
`queryParams` is an object.
It returns the `EasyFetch` or `JsonFetch` class instance in order to chain calls.
*Should be called before `_fetch`.*
### `setOptions(options)`
Set options for `fetch`.
`options` is an object.
It returns the `EasyFetch` or `JsonFetch` class instance in order to chain calls.
*Should be called before `_fetch`.*
### `basicAuth(login, password)`
Set the `Authorization` header to `Basic` with `login` and `password`.
It returns the `EasyFetch` or `JsonFetch` class instance in order to chain calls.
*Should be called before `_fetch`.*
### `head()`
It returns the promise returned by `fetch`.
*Calls `_fetch`.*
### `get()`
It returns the promise returned by `fetch`.
*Calls `_fetch`.*
### `post(body)`
It returns the promise returned by `fetch`.
*Calls `_fetch`.*
### `put(body)`
It returns the promise returned by `fetch`.
*Calls `_fetch`.*
### `patch(body)`
It returns the promise returned by `fetch`.
*Calls `_fetch`.*
### `delete(body)`
It returns the promise returned by `fetch`.
*Calls `_fetch`.*
## Usage Example
```javascript
import {easyFetch, jsonFetch} from 'easyfetch'
var data = {test: "data", field: "test", field2: 1}
var formdata = Object.keys(data).map((k) => [k, encodeURIComponent(data[k])].join('=')).join('&')
easyFetch("https://httpbin.org/get").get()
.then(response => /* do what you want with the response */)
.catch(error => console.log(error.response))
easyFetch("https://httpbin.org/post")
.setHeaders({"Content-Type": "application/x-www-form-urlencoded"})
.post(formdata)
.then(response => response.json())
.catch(error => console.log("Request failed: ", error.response))
jsonFetch("https://httpbin.org/get")
.setHeaders({'X-Api-Key': config.easyPOSLogApi.apiKey})
.get().then(data => console.log(data))
jsonFetch("https://httpbin.org/post").post(data)
.then(data => console.log(data))
```
# Contributing
Feel free to open issues and submit pull-requests.