https://github.com/chickencoding123/yafetch

Yet another fetch is a backward compatible, dependency free, drop-in wrapper for fetch API
https://github.com/chickencoding123/yafetch

alternatives backward-compatibility fetch fetch-api retry

Last synced: about 1 month ago
JSON representation

Yet another fetch is a backward compatible, dependency free, drop-in wrapper for fetch API

• Host: GitHub
• URL: https://github.com/chickencoding123/yafetch
• Owner: chickencoding123
• License: mit
• Created: 2022-02-08T20:24:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-25T03:59:15.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T17:12:27.441Z (about 2 months ago)
• Topics: alternatives, backward-compatibility, fetch, fetch-api, retry
• Language: TypeScript
• Homepage: https://chickencoding123.github.io/yafetch
• Size: 813 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        



Yet another fetch is a dependency free HTTP client wrapper for node.js and browser

  

[![npm](https://img.shields.io/npm/v/@yafetch/core)](https://www.npmjs.com/package/@yafetch/core) [![License](https://img.shields.io/npm/l/@yafetch/core)](https://github.com/chickencoding123/yafetch/blob/main/LICENSE) [![bundle size](https://img.badgesize.io/https:/unpkg.com/@yafetch/core/dist/index.js?max=300000&compression=gzip)](https://unpkg.com/@yafetch/core/dist/index.js)



## Features

- Plugins for various features such as retries, error handling, logging, parsing etc...

- Defaults to _fetch_ as HTTP client, but can be used with any HTTP client such as [node-fetch](https://github.com/node-fetch/node-fetch)

- Automated parsing of request/response data

- Global options

- ... and more

## How to use

```sh

npm i @yafetch/core --save

# or

yarn add @yafetch/core --save

```

Usage is mostly similar to _fetch_ API:

```ts

import yafetch from '@yafetch/core'

const html = await yafetch('https://www.example.com') // as opposed to fetch('https://www.example.com')

```

`yafetch` automatically converts `body` to `URLSearchParams` for `GET` requests:

```ts

import yafetch from '@yafetch/core'

const html = await yafetch('https://www.example.com', { body: { name: 'john' } }) // will send https://www.example.com/?name=john

```

## Plugins

The most powerful aspect of `yafetch` is its plugin system, allowing full control over the API calls. There are three types of plugins categorized by their execution order relative to the main API call, "before" and "after" plugins run before or after the API request while "wrap" plugins will wrap the API call itself. These wrap plugins also wrap each other allowing for communication between multiple plugins and advanced scenarios such as retries, error handling etc...

## Custom HTTP client implementation

`Yafetch` you can provide an alternative proxy function to use instead when running in a non-browser environment such as node.js. To use this feature simply pass a `fetchProxy` in the options, from there it's up to you how the API call happens. See an example of this in tests under the `core` package.

## Contribution

Please make sure to read the [Contributing Guide](https://github.com/chickencoding123/yafetch/blob/main/.github/CONTRIBUTING.md) before you work on this project.

## License

[MIT](https://opensource.org/licenses/MIT)