Code Monkey home page Code Monkey logo

create-request's Introduction

@bitty/create-request

License Library minified size Library minified + gzipped size

Apply interceptors to fetch and create a custom request function.

  • โšก Dependency free and pretty small, 0.3KB (minified + gzipped);
  • ๐Ÿท๏ธ Well type defined with TypeScript (with generics);
  • ๐Ÿ“ฆ There are ESM, CommonJS and UMD distributions;

Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

npm install @bitty/create-request --save

# Use the command below if you're using Yarn.
yarn add @bitty/create-request

Usage

@bitty/create-request is curry function, which applies interceptors to fetch and returns a new request function.

import createRequest from '@bitty/create-request';

type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';

const request = createRequest(window.fetch, {
  onRequest: (method: Method, route: string, data: any = undefined) => ({
    url: 'https://api.example.com' + route,
    body: JSON.stringify(data),
    method,
    headers: { 'Content-Type': 'application/json' }
  }),
  onResponse: (response: Response) => {
    if (response.status === 403)
      throw new Error('Authorization error.');
    return response.json();
  },
  onError: (error:? Error) => {
    sentry.captureException(error);
    return Promise.reject(message);
  }
});

request('POST', '/user', {
  name: 'Vitor'
})
  .then((response) => response.success && alert('User was created!'));

Interceptors

  • onError

    onError?: (reason?: Error) => Promise<never>;

    Handle request and response errors.

  • onRequest

    onRequest?: <A extends any[] = [RequestOptions]>(...params: A) => RequestOptions;

    Handle request and define request arguments. A generic type defines returned request function arguments type.

    onRequest GIF

  • onRequestError

    onRequestError?: (reason?: Error) => Promise<never>;

    Handle request errors. Overwrites onError handling request errors.

  • onResponse

    onResponse?: <R = Response>(response: R) => R | PromiseLike<R>;

    Handle response and define the request return. R generic type defines returned request function result type.

    onResponse GIF

  • onResponseError

    onResponseError?: (reason?: Error) => Promise<never>;

    Handle response errors. Overwrites onError handling response errors.

Usage on unsupported browsers

Do I support fetch?

Older browsers don't support Fetch API, but you can use unfetch or other polyfill to achieve it.

import fetch from 'unfetch';
import createRequest from '@bitty/create-request';

export default createRequest(fetch, {
  onRequest: (options) => ({
    ...options,
    headers: {
      ...options.headers,
      'Content-Type': 'application/json'
    }
  }),
  onResponse: (response) => response.json()
});

Usage on Node.js

Node environment does not provide global fetch function, but you can use node-fetch to achieve it.

const fetch = require('node-fetch');
const createRequest = require('@bitty/create-request');

module.exports = createRequest(fetch, {
  onResponse (response) {
    return response.json();
  }
});

License

Released under MIT License.

create-request's People

Contributors

vitorluizc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

mechamobau

create-request's Issues

Rename and put inside @vitorluizc scope

intereq is a pretty bad name and all the others are already taken, so using my scope I can choose a good name.

Currently, the options are:

  • create-request
  • request
  • fetch-interceptors
  • fetch
  • req

Named export normalizeURL helper

const normalizeURL = (...parts) => {
  const URL = /^(https?:\/\/)?(.*)$/;
  const [, protocol = 'https://', body] = URL.exec(parts.join('/'));
  return protocol + body.replace(/(\/+)/g, '/');
};

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.