prom-time v1.0.0

What time is it?

It's promTime!

This is a small implementation of a uniform interface built to measure the runtime of synchronous and asynchronous (promise-based) functions. This is achieved in addTimer, which wraps functions into promises that return both their value and runtime. timeResolution and isPromise are extra utilities that are part of addTimer, but also may prove useful on their own. Note that the timing functionality won't work for callback-based async functions.

Install

npm i prom-time

Usage

This repo includes the following:

• index.js
• addTimer.js
• timeResolution.js
• isPromise.js

addTimer.js

Takes in a function, returns a version of the function that returns a promise that resolves to an object with a val and time on it. time is the elapsed time in ms from the promise's creation to its resolution. If the function's returned value is not a promise, it will be wrapped in a promise.

input: <function> output: <promise> output.then(data=>data): { val: <data> time: <time in ms> }

Example:

const {addTimer} = require('prom-time')
const timedFunction = addtimer(<function>);
timedFunction().then(data=>{
  console.log(data.time);
  return data.val;
})

timeResolution.js

Takes in a promise, and returns a promise that resolves to an object containing both the returned data from the promise and the time elapsed in ms. If the input value is not a promise, it creates a promise that will resolve to the output of the synchronous function.

input: <value> output: <promise> output.then(data=>data): {val: <data>, time:<time in ms>}

Example:

const {timeResolution} = require('prom-time');
timeresolution(<promise or value>).then(data=>{
  console.log(data.time);
  return data.val;
})

isPromise.js

takes a val, returns true if it's a promise (or at least has a .then), false if it doesn't.

input: <value> output: <boolean>

Example:

const {isPromise} = require('prom-time');
isPromise(5); //false