npm i @yafetch/core --save
# or
yarn add @yafetch/core --save
Usage is mostly identical, besides a few added features, to the standard fetch API:
import yafetch from '@yafetch/core'
const html = await yafetch('https://www.example.com') // as opposed to fetch('https://www.example.com')
The only exception is the ability to pass body
for GET
requests, which yafetch
will convert to URLSearchParams
automatically:
import yafetch from '@yafetch/core'
const html = await yafetch('https://www.example.com', { body: { name: 'john' } }) // will send https://www.example.com/?name=john
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...
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.
Please make sure to read the Contributing Guide before you work on this project.
Generated using TypeDoc