cardio-node v1.0.4

What is Cardio?

Cardio is a node.js module that tells you how long an async function took to run.

Use it as a wrapper around an async function and you get the execution duration and arguments provided to your function within a callback. You can now use this information to plot graphs, create models based on different arguments provided, or simply make a note somewhere for analysis.

Cardio works best in production environments where you may expect variance in execution time based on arguments provided, environmental overheads, or other real world parameters.

Cardio has zero dependencies on external libraries

This allows Cardio to stay under 15kB when packaged

Usage

Import cardio-node by running npm install cardio-node or yarn add cardio-node

Use the module in code using require:

const { cardioWrapper } = require('cardio-node');

Or using ES6 Imports:

import { cardioWrapper } from 'cardio-node';

Wrap your async function using cardioWrapper in your application. You can substitute the call to your async function with the call to what is returned by cardioWrapper:

const countSheep = async (arg1, arg2) => {
  // ...perform elaborate sheep counting here
  return arg1 + arg2;
};

const countSheepWithCardio = cardioWrapper(
  'count-sheep',
  countSheep,
  (cardioName, invocation, args) => {
    // You have args here if you want access to what was passed to countSheep
    const durationRounded = new Number(invocation.duration).toPrecision(2);
    console.log(
      `Function registered as ${cardioName} took ${durationRounded} milliseconds to run`
    );
  }
);

(async () => {
  const numberOfSheep = await countSheepWithCardio(4, 5);
  console.log(`Counted ${numberOfSheep} sheep in total`);
})();

Output:

Function registered as count-sheep took 0.073 milliseconds to run
Counted 9 sheep in total

Take a look at the code for a sample application for a full fledged example of how you can use cardio-node.

API

The cardioWrapper method takes in the following arguments:

cardioCallback gives you three arguments:

invocation object has the following fields:

Inspiration

I was on vacation with a few friends and we found the gym closed in our hotel due to covid. It was 37C outside so going for a run was out of the question. Discussions around not getting any cardio done somehow eventually mixed with discussions about code.

Shoutout to @tallpants and @deusv0lt for brainstorming.

Built using TSDX