npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

whats-the-damage

v2.0.3

Published

What's the damage? ...of running that script in real time, CPU time, and memory usage

Downloads

11

Readme

What's the Damage? ...of running that script in time, CPU and memory usage

Runs scripts and benchmarks their execution time, CPU usage, and memory usage by running each script many times, and returning an average of all results.

Install:

npm install whats-the-damage

Usage:

import DamageOf from 'whats-the-damage';

DamageOf([
  '/path/to/script1.js',
  '/path/to/script2.js'
]).then(damages => {
    console.log(damages);
})

(because it's a promise you can await the results too of course)

The promise will return an array of results, each of which look like...

{
  "time": AVERAGE,
  "cpu": {
    "user": AVERAGE,
    "system": AVERAGE
  },
  "memory": {
    "rss": AVERAGE,
    "heapTotal": AVERAGE,
    "heapUsed": AVERAGE,
    "external": AVERAGE
  },
  "snapshot": {
    "everyMilliseconds": 1000,
    "snapshots": [
      {
        "cpu": AVERAGE,
        "memory": AVERAGE,
        "time": AVERAGE
      },
      {
        "cpu": AVERAGE,
        "memory": AVERAGE,
        "time": AVERAGE
      },
      ...
    ]
  },
  "exitCode": 0,
  "repeat": 10
}

AVERAGE is a statistical analysis of multiple executions of your script which looks like,

{
  "mean": 5.584533965,
  "median": 5.584533965,
  "standardDeviation": 0.08703098499999973,
  "max": 5.67156495,
  "min": 5.49750298
}

So if you just want to see how long (on average) your script takes to run you could...

const damages = await DamageOf(['/path/to/script1.js']);
console.log(damages[0].time.mean);

How does it work?

It forks your scripts and runs them sequentially while monitoring the processes' memory, CPU usage, and duration.

API

DamageOf

DamageOf(pathsArray, OPTIONS);

I've already explained the first argument (an array of full script paths).

OPTIONS is an optional object that is merged with default options, which are,

async: false, // Boolean.
              // Running tests in parallel will cause eratic results.
              // so not recommended to set to true.
              // Perhaps useful if you're trying to get a quick and
              // broad overview of results though.

snapshotEveryMilliseconds: 1000, // number in milliseconds
                                 // when watching the script, snapshot
                                 // the memory/cpu/time this frequently

repeat: 10, // number of times to run each script

progress: (...args) => {} // A callback that receives progress updates
                          // because benchmarks can take a while.
                          // Defaults to printing to console.log.
                          // Can be set to null to silence it.
                          // The args can be anything and this isn't yet
                          // standardised

getEnvironment()

Returns an object that looks like,

{
  versions: process.versions,
  arch: os.arch(),
  cpus: os.cpus(),
  totalmem: os.totalmem(),
  type: os.type()
}

Useful for distinguishing benchmarks across different machines.

See the Node.js docs for process and os for more.

whats-the-damage is part of the XML-Zero.js project.