@supersimplethings/fetcher

Things should be simple to use

Heavily rtped polite fetch library based on modular middleware system.

Usage

async function getResponse(someArgs) {
  const body = {
    some: someArgs.some,
    args: someArgs.args
  }
  const response = await fetcher().post(body).to('https://some.site/endpoint').plz()
}

Installation

With npm:

npm install @supersimplethings/fetcher

With yarn:

yarn add @supersimplethings/fetcher

Advanced usage

import { Fetcher, MiddlewareTarget } from '@supersimplethings/fetcher'

const ourApi = {
  name: 'ourApi',
  domain: 'https://some.domain',
  endpoints: {
    user:{
      byId: userId => `/users/${userId}`
    }
  }
}

const token = 'some_token'

const fetcher = new Fetcher(ourApi)
  .useApi('ourApi')
  .setOptions({ headers: { Authorization: `Bearer: ${token}` }})
  .useMiddleware(MiddlewareTarget.body, someBodyParser)

async function updateUser(someArgs, userId) {
  const body = {
    some: someArgs.some,
    args: someArgs.args
  }
  const user = await fetcher.put(body).to().user.byId.with(userId).plz()
}

Default middleware

You can override default behaviour with useMiddleware method:

useMiddleware(on: MiddlewareTarget, middleware: Middleware[]): Fetcher {
  this.middleware[on] = middleware
  return this
}

enum MiddlewareTarget {
  response = 'response',
  body = 'body',
  resolve = 'resolve',
  reject = 'reject'
}

Defaults are:

import { error, success } from './utils'
import { statusNotOk, stringify, takeJson } from './middleware'

middleware: Middleware = {
  body: [stringify],
  response: [statusNotOk, takeJson],
  resolve: [success],
  reject: [error],
}

Server usage

Fetcher supports server usage through node-fetch:

constructor(apis?: Api | Dictionary<Api>) {
  if (!fetch) this.provider = require('node-fetch').default
}

License

MIT

leeratyou / fetcher