README.md

yab-fetch

A fetch library.

Table of Content

• Features
• Browser Support
• Install
  • npm
  • yarn
  • CDN
• Useage
  • createFetch(url[, options])
  • Instance methods
  • Middleware
    • yab.use(middleware)
    • middleware function
• Type usage with TypeScript
• Liscense

Features

• Middleware: koa-like middleware.
• Fetch: base on browser fetch API.
• TypeScript: Everything in Typescript.

Browser Support

This library can only be used in modern browser environment. Polyfill may be needed.

Install

npm

npm install yab-fetch

yarn

yarn add yab-fetch

CDN

<script src="https://unpkg.com/yab-fetch.min.js"></script>

Useage

createFetch(url[, options])

options:

{
  baseUrl: '', // base url
  data: {}, // post data
  use: [], // middlewares
  resolveData: (ctx) => {} // resolve data from ctx
  responseType: 'json'|'text'| 'arrayBuffer' | 'blob' // auto resolve
  before: (request) => {} // handle request before fetch
  after: (response) => {} // handle response after fetch
}

Instance methods

import { createFetch } from 'yab-fetch';
const instance = createFetch();

instance.get(url[, options]); // HTTP GET
instace.post(url[, options]); // HTTP POST

Middleware

yab.use(middleware)

import { createFetch } from 'yab-fetch';
const instance = createFetch();

instance.use(async (ctx, next) => {
  await next();
});

middleware function

Type usage with TypeScript

This module is written in TypeScript and the types are published to npm;

Liscense

MIT