https://github.com/typicode/fetchival
Easy window.fetch requests
https://github.com/typicode/fetchival
Last synced: 8 months ago
JSON representation
Easy window.fetch requests
- Host: GitHub
- URL: https://github.com/typicode/fetchival
- Owner: typicode
- License: mit
- Created: 2015-04-21T03:15:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-06T06:35:21.000Z (about 7 years ago)
- Last Synced: 2025-04-03T09:11:12.203Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 67.4 KB
- Stars: 521
- Watchers: 10
- Forks: 32
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fetchival.js [](https://travis-ci.org/typicode/fetchival)
> Makes writing JSON requests with [fetch](https://github.com/github/fetch) easier
Fetchival is a tiny (0.5kb min/gz) fetch wrapper that can be used in the __browser__ (IE9+) and __Node__.
__Before__
```javascript
// POST /users
fetch('/users', {
method: 'post',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Typicode',
login: 'typicode',
})
})
.then(function(response) {
if (response.status >= 200 && response.status < 300) {
return response.json()
}
throw new Error(response.statusText)
})
.then(function(json) {
// ...
})
```
__After__
```javascript
// POST /users
fetchival('/users').post({
name: 'Typicode',
login: 'typicode'
})
.then(function(json) {
// ...
})
```
`.get()`, `.put()`, `.patch()` and `.delete()` methods are also available.
## Installation
Fetchival is available on Bower and npm
__Browser__
```bash
bower install es6-promise fetch # polyfills
bower install fetchival
```
```bash
npm install es6-promise whatwg-fetch --save # polyfills
npm install fetchival --save # Browserify
```
__Node__
```bash
npm install node-fetch fetchival --save
```
## Usage examples
```javascript
var posts = fetchival('/posts')
//posts
posts.get()
posts.post({ title: 'Fetchival' })
//posts?category=javascript
posts.get({ category: 'javascript' })
//posts/1
posts(1).get()
posts(1).put({ title: 'Fetchival is simple' })
posts(1).patch({ title: 'Fetchival is simple' })
posts(1).delete()
var comments = posts('1/comments')
//posts/1/comments
comments.get()
//posts/1/comments/1
comments(1).get()
```
You can also pass fetch options to `fetchival()`
```javascript
var posts = fetchival('/posts', fetchOptions)
var comments = posts('1/comments') // Will inherit fetchOptions
```
To catch errors
```javascript
fetchival('/posts')
.get()
.catch(function(err) {
console.log(err)
})
```
To enable CORS
```javascript
var request = fetchival('/', { mode: 'cors' })
var posts = request('posts')
```
To fetch plain text (for example, HTML views)
```javascript
var request = fetchival('/', { responseAs: 'text' })
var posts = request('posts')
```
`responseAs` can be `response`, `text` or `json` (default)
To use fetchival in Node, you need to install `node-fetch` and configure fetchival to use it
```javascript
var fetchival = require('fetchival')
fetchival.fetch = require('node-fetch')
```
## Browser Support
 |  |  |  | 
--- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | 9+ ✔ | Latest ✔ | 6.1+ ✔ |
## License
MIT - [Typicode](https://github.com/typicode)