Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shnhrrsn/fetchit
Extra utilities for `fetch` that works in both Node and the browser.
https://github.com/shnhrrsn/fetchit
Last synced: 26 days ago
JSON representation
Extra utilities for `fetch` that works in both Node and the browser.
- Host: GitHub
- URL: https://github.com/shnhrrsn/fetchit
- Owner: shnhrrsn
- License: mit
- Created: 2017-10-17T21:46:10.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-11-12T04:46:39.000Z (12 months ago)
- Last Synced: 2024-09-17T16:41:59.991Z (about 2 months ago)
- Language: JavaScript
- Size: 1.49 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG.markdown
- License: LICENSE
Awesome Lists containing this project
README
# fetchit
`fetchit` provides additional utilities for [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) that works in both Node and the browser.
## Compatibility
fetchit 4 requires Node 18 or later and is no longer compatible with node-fetch.
To use with earlier versions of Node, please use fetchit@^3
## Installation
### yarn
```bash
yarn add fetchit
```
### npm
```bash
npm install --save fetchit
```
## Documentation
By default, `fetchit` works identically to [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) with the exception that it will throw a [StatusCodeError](src/StatusCodeError.js) for non-200 responses.
In addition to the standard `fetch` API, `fetchit` adds a few extra utilities:
### fetchit.json
`fetchit.json()` accepts the same arguments as `fetch`, but rather than the full response object, it will return a JSON object:
```js
import fetchit from 'fetchit'
console.log('result', await fetchit.json('https://httpbin.org/anything'))
```
### fetchit.text
`fetchit.text()` accepts the same arguments as `fetch`, but rather than the full response object, it will return the response body as a string:
```js
import fetchit from 'fetchit'
console.log('result', await fetchit.text('https://httpbin.org/robots.txt'))
```
### Functional Access
In addition to `fetchit.json()` and `fetchit.text()`, you can access them in a functional way as well:
```js
import fetchit, { json, text } from 'fetchit'
console.log('result', await json(fetchit('https://httpbin.org/anything'))
console.log('result', await text(fetchit('https://httpbin.org/robots.txt'))
```
### options
`fetchit` supports additional `options` beyond what `fetch` provides by default:
#### query
You can pass in a `query` object to be formatted and tacked onto the URL as a query string:
```js
const fetch = require('fetchit')
console.log(
'result',
await fetch.json('https://httpbin.org/get', {
date: Date.now(),
boolean: true,
string: 'string',
}),
)
```
#### form
You can pass in a `form` object and `fetchit` will setup an `application/x-www-form-urlencoded` request body:
```js
const fetch = require('fetchit')
console.log(
'result',
await fetch.json('https://httpbin.org/form', {
method: 'POST',
form: {
date: Date.now(),
boolean: true,
string: 'string',
},
}),
)
```
#### body
If you pass an object to `body`, `fetchit` will setup a `application/json` request body:
```js
const fetch = require('fetchit')
console.log(
'result',
await fetch.json('https://httpbin.org/form', {
method: 'POST',
body: {
date: Date.now(),
boolean: true,
string: 'string',
},
}),
)
```
> Note: If you pass in a `FormData` instance as the value of `body` or you provide a `Content-Type` header, the standard `fetch` behavior will apply for `body`.
#### credentials
Unlike `fetch`, by default, `fetchit` will set [`credentials`](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials) to `same-origin`.
## License
`fetchit` was created by [Shaun Harrison](https://github.com/shnhrrsn) and is made available under the [MIT license](LICENSE).