fatcher
v3.0.0-alpha-10
Published
Send fetch request gracefully in browsers and nodeJS
Downloads
802
Maintainers
Readme
Send fetch request gracefully in browsers and nodeJS
Introduction
Fatcher
is a lightweight HTTP request library based on fetch
. It allows us to use native fetch
for web requests in a browser and NodeJS environment.
It is wrapped using the native fetch
, we require that browsers or NodeJS support fetch
when we use it.
- Fetch support is already pretty good in modern browsers.
- In NodeJS, fetch already support with
18.0.0
Fatcher
aims to embrace the fetch
of the standard library and at the same time provide some functions that cannot be provided in fetch
, as well as make the function better expand and reuse.
Features
- Fully compatible with fetch api
- Zero dependencies
- Tiny: less than 1kb
- Works in Node.js and all modern browsers
- Composable middleware
- Streaming API
Compatibility
Browsers
NodeJS
Getting Started
Install
NPM
>$ npm install fatcher
CDN
<script src="https://cdn.jsdelivr.net/npm/fatcher/dist/fatcher.min.js"></script>
Usage
Basic
Fatcher
is fully compatible with fetch api.
const fetchOptions = {
/* options */
};
fetch('https://foo.bar', fetchOptions);
// is similar to
import { fatcher } from 'fatcher';
fatcher('https://foo.bar', fetchOptions);
Middleware
Everything is middleware, middleware is a function which is like in koa
export type FatcherMiddleware = (
request: FatcherRequest,
next: (request?: Partial<FatcherRequest>) => Promise<FatcherResponse> | FatcherResponse,
) => Promise<FatcherResponse> | FatcherResponse;
We can pass the request context to next middleware and get the response form next middleware.
We should call the next function and return the response to prev middleware.
import { defineMiddleware } from 'fatcher';
const logs = defineMiddleware(async (request, next) => {
const startTime = Date.now();
const response = await next({
url: 'https://foo.bar1',
});
const now = Date.now();
console.log(`spent ${now - startTime}ms`);
return response;
});
fatcher('https://foo.bar', { middlewares: [logs] }); // sent to 'https://foo.bar1' instead of 'https://foo.bar'
Exception Handling
In the fetch api, all requests are considered successful. However, we generally consider a request with a response code of 200-299
to be successful.
import { exception, fatcher, isFatcherError } from 'fatcher';
fatcher('https://foo.bar', { middlewares: [exception()] }).catch(error => {
if (isFatcherError(error)) {
// handle fatcher error
return;
}
// handle other error
});
Packages
- @fatcherjs/middleware-aborter
- @fatcherjs/middleware-cache
- @fatcherjs/middleware-form-data
- @fatcherjs/middleware-json
- @fatcherjs/middleware-parameter
- @fatcherjs/middleware-progress