Nearsighted Paramecium Multiverse
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

kefetchup

1.2.0 • Public • Published

Build Status Coverage status npm npm bundle size (minified) dependencies (minified)

Simple fetch client API to spice up your application

npm i -S kefetchup

What is it?

It's just a small and very extendable fetch client made for our company's purposes.

Kefetchup aims to help you move your API calls into a higher generic abstraction by providing necessary tools for it.

Basic operation principles (API TLDR)

kefetchup provides several classes and utilities to help you with building your custom API client:

import {
  // A generic wrap around fetch to provide rich customization and exception handling. 
  // Outputs a standard fetch response for each request.
  GenericAPIClient,
 
  // A simple class that extends GenericAPIClient.
  // The only difference is that it returns straight parsed JSON object, instead of a fetch response.
  JsonAPIClient,
 
  // Same as previous, but returns plain strings instead of json.
  TextAPIClient,
 
  // An exception class to use in your error handlers for server-returned errors. Provides statuses and stack traces.
  ResponseError,
 
  // A comprehensive list of all possible HTTP errors.
  ResponseErrors,
 
  // A helper function to encode query params into a string.
  withQuery
} from 'kefetchup'

You'll be fine extending JsonAPIClient in most cases. Though, for finer control we recommend using GenericAPIClient.

Usage example

A typical usage example is as follows (using GenericAPIClient):

import { GenericAPIClient, ResponseError, withQuery } from 'kefetchup'
 
class MyApiClient extends GenericAPIClient {
 
  /**
   * You can override this method to pipe all your responses with it.
   * @override to recieve json instead of a fetch response (like in JsonAPIClient)
   * 
   * @param resp {Response} a standard fetch response: https://developer.mozilla.org/en-US/docs/Web/API/Response
   */
  async responseHandler(response) {
    const resp = super.responseHandler(response);
 
    // Let's say we want to throw errors for 400+ statuses too
    if (resp.status >= 400) {
      throw new ResponseError(MyApiClient.handleStatus(resp.status), resp.status, resp);
    }
 
    return await resp.json();
  }
 
  constructor(myVeryImportantSetting) {
    super(
      // Provide a base endpoint for your client
      'https://my-api-server.com/api',
 
      // Provide generic request options used in most of your requests
      {
        // For example - common headers (here we want to send basic token with each request)
        headers: {
          'Authorization': 'Basic kjhkowgurgybihfjqwuoe968tgyib3jqipwfe08s79d=='
        }
      }
    );
 
    // Set a custom variable to the instace
    this.myVeryImportantSetting = myVeryImportantSetting;
  }
 
  // In class' body we can write custom method handlers for our API calls
  async getImportantThingsList() {
    try {
      // Send a GET request to 'https://my-api-server.com/api/important-things?importance=high&amount=5&type={value-of-myVeryImportantSetting}'
      return await this.get(withQuery('/important-things', {
        importance: 'high',
        amount: 5,
        type: this.myVeryImportantSetting
      }));
    } catch (e) {
      // e instanceof ResponseError === true
      // Here you can handle method-specific errors
 
      if (e.status === 401) {
        console.error('Token is incorrect for', e.data);
 
        return [];
      } else {
        throw e;
      }
    }
  }
}

And then just

const myApi = new MyApiClient();
 
myApi.getImportantThingsList().then(things => {
  // do things with your important things...
}).catch(e => {
  // and catch your errors properly...
});

Keywords

none

Install

npm i kefetchup

DownloadsWeekly Downloads

6

Version

1.2.0

License

MIT

Unpacked Size

188 kB

Total Files

43

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar