request-state-wrapper

Request State Wrapper

A small, less than 1kb gzipped, utility wrapper for Asynchronous JavaScript events.

It allows you to easily handle fetching, stalled and finished states.

Philosophy

The way we handle loading states in front end applications can be incredibly reptetive and imperative.

We also design loading states that aren't always the optimal user experience for all users. This means users with fast AND slow connections.

Request state wrapper aims to solve the following problems.

• Make it easy to detect stalled loading states so we can communicate to users on slower connections that the app is still working / not broken.
• Take the reptetive code required to handle loading states, and compose it into a single, declarative utility function. This helps keep our codebases DRY(Dont Repeat Yourself).

Usage

npm install --save request-state-wrapper

import { createRequest } from 'request-state-wrapper';

const yourAsyncFunction = fetch('https://api.com.au')
    .then(response => response.json());

// Create your request with request-state-wrapper
const request = createRequest({
    request: [yourAsyncFunction],
    stalledDelay: 1000,
    onStateChange: state => { 
        // handle fetching, stalled and finished states here... 
    },
});

// run it!
request()
    .then(response => {
        // handle response here...
    })
    .catch(error => {
       // handle error here... 
    })

Usage recipies

For more detailed implementation recipies see:

• Vanilla JavaScript with explicit event handlers
• React Hooks
• Reusable React provider component
• React with Redux

API

createRequest takes a single object argument.

const demoRequest = createRequest({ 
    request,
    stalledDelay,
    onStateChange,
    onFetching,
    onStalled,
    onFinished,
 })

Required

• request - Array of one or more promises

Optional

• stalledDelay - Time, in milliseconds, it takes for the request to be considered stalled
• onStateChange - Handler function that is called whenever the request state changes
• onFetching - Handler function that is called whenever the request starts fetching
• onStalled - Handler function that is called whenever the request state becomes stalled
• onFinished - Handler function that is called whenever the request state finishes

createRequest returns a function that invokes the request. It takes a single argument, an object of options all of which are optional.

demoRequest({
    onStateChange,
    onFetching,
    onStalled,
    onFinished,
 })

• onStateChange - Handler function that is called whenever the request state changes
• onFetching - Handler function that is called whenever the request starts fetching
• onStalled - Handler function that is called whenever the request state becomes stalled
• onFinished - Handler function that is called whenever the request state finishes

Important:

• Any options declared at request time will override options declared at creation time
• onFetching, onStalled, onFinished take precedence over onStateChange