bard-instruments

bard-instruments

Utilities for every day development challenges in JS/SPA/Mobx/React web applications.

It is a basket of utils to cherry pick that I improve and test over time.

(See section "part of Bard Ecosystem" for details at the end of the docs).

How to use

Some utils rely on lodash 4.x, so it is needed as peer|dependency.

Install

npm install bard-instruments
npm install lodash@4

Require / import

All utils are in their own module under /lib. Many of them work both in Nodejs and browser.
Importing is different if you use ES6 or CJS.

Example:

// Node / cjs
const RateLimitPromiseQueue = require('bard-instruments/lib/async/RateLimitPromiseQueue').default
// ES6
import RateLimitPromiseQueue from 'bard-instruments/lib/async/RateLimitPromiseQueue'

const promiseQueue = new RateLimitPromiseQueue({minTimeBetweenTasks: 1000})

Util list

This is a simple list. The source code has more detailed usage example.

async utils

• /async/promiseAllProps
  Wait for a map of promises; fails as soon as one fails.

• /async/promiseAllPropsResults
  Wait for a map of promises; does not fail; failed promises values will be the corresponding error.

• /async/promiseAllResults
  Wait for an array of promises; does not fail; failed promises values will be the corresponding error.

• /async/RateLimitPromiseQueue
  Promise queue that enforces an amount of time that must have passed between each task. Typical use case: request rate limit to an API.

• /async/sleep
  Delay the execution of a Promise Chain.

axios utils

• /axios/createRateLimitAdapter
  Add rate limit management on an axios instance.

DOM utils

• /dom/injectCss
  Inject css rules into the document head.

Mobx utils

• /mobx/AsyncDateModel
  Observable model of typical asynchronous data state.

• /mobx/ObservableViewport
  Expose observable properties of the browser viewport.

react-mobx utils

• /withVM
  Higher order component that allows to connect easily a mobx root store to a component via React context api.

• /withVM2
  Same as withVM but newer implementation using mobx-react@6 and React hooks.
  This one does not have a custom injection option like withVM but this could be added in the future.

Choose one based on your current dependencies.

Part of the "Bard ecosystem"

I am developing an ecosystem to easily build frontend apps based on React and Mobx. The utils are loosely related to each other, so that they can be shared in javascript projects, especially in the "Bard ecosystem".

More info:

• bard-router

Changelog

3.0.0-beta.0 (2021-03-07)

⚠ BREAKING CHANGES

• • Simplify folders by moving withVM to lib/mobx Not you need to import from bard-instruments/lib/mobx/withVM

• AsyncDataModel is now called AsyncData

• update to mobx6 + AsyncData + move withVM to mobx folder (f2f04ab)