JSPM

  • Created
  • Published
  • Downloads 44990
  • Score
    100M100P100Q35649F
  • License MIT

oh-my-fetch

Package Exports

  • ohmyfetch

Readme

😱 0fetch

npm version npm downloads Github Actions Codecov

🚀 Quick Start

Install:

# npm
npm i 0fetch

# yarn
yarn add 0fetch

Import:

// Browser / Workers
import { $fetch } from '0fetch/browser'

// NodeJS
import { $fetch } from '0fetch/node'

// NodeJS (commonjs)
const { $fetch } = require('0fetch/node')

🤔 Why?

✔️ Parse Response

😌 $fetch:

const { users } = await $fetch('/api/users')
  • Using destr
  • Smartly parse JSON and native values like true
  • Fallback to text if cannot parse
  • Secure against prototype pollution

🥺 fetch:

const { users } = await fetch('/api/users').then(r => r.json())

✔️ Handle Errors

😌 $fetch:

await $fetch('http://google.com/404')
// FetchError: 404 Not Found (http://google.com/404)
//     at async main (/project/playground.ts:4:3)
  • Automatically throw errors when response.ok is false
  • Friendly error message with compact stack (hiding internals)
  • Parsed error body is available with error.data

🤷 fetch:

const resonse = await fetch('http://google.com/404')
// You need to manually check response.ok and throw an error

✔️ Type Friendly

😌 $fetch:

const { article } = await $fetch<Article>(`/api/article/${id}`)
// article object is type assisted
  • Expected response type can be specified

🥺 fetch:

const { article } = await fetch(`/api/article/${id}`).then(r => r.json())
// article type is any

✔️ Support baseURL

😌 $fetch:

await $fetch('/config', { baseURL })
  • Allow making factory functions to add baseURL
  • Prepend baseURL with respecting traling/leading slashes and query params for base (using ufo)

🤷 fetch:

await $fetch(baseURL + '/config')

✔️ Univeral

Supporting browsers, workers and NodeJS

📦 Bundler Notes

  • All targets are exported with Module and CommonJS format and named exports
  • No export is transpiled for sake of Modern syntax
    • You probably need to transpile 0fetch package with babel for ES5 support
  • You need to polyfill fetch global for supporting legacy browsers like using unfetch

❓ FAQ

Why package name is not simpler?

Ask who took all cool names and kept unused. Also ofetch is not available due npm similar naming policy. 🤷

Why export is called $fetch instead of fetch?

Using same name of fetch can be confusing since API is different but still it is a fetch so using closes possible alternative.

Why note having default export?

Default exports are always risky to be mixed with CommonJS exports.

This also guarantees we can introduce more utils without breaking package and also encourage using $fetch name.

Why not transpiled?

By keep transpiling libraries we push web backwards with legacy code which is unneeded for most of users.

If you really need to support legacy users, can optionally transpile library in build pipelines.

License

MIT. Made with 💖