Mempoll

A simple NodeJS memory usage poller.

Installing

npm install mempoll
Copy

Documentation

Documentation and more detailed examples are hosted on Github Pages.

Usage

import { poll } from "mempoll";

poll();
Copy

This will print a summary every second:

┌────────────────────┬────────┐
│      (index)       │ Values │
├────────────────────┼────────┤
│      Rss / MB      │   28   │
│  Heap total / MB   │ 4.102  │
│   Heap used / MB   │ 2.275  │
│   External / MB    │ 1.074  │
│ Array buffers / MB │  0.01  │
└────────────────────┴────────┘
Copy

Parameters

import { Worker } from "worker_threads";

const poll: (interval: number = 1000, resolution: number = 3) => Worker;
Copy

• Interval: Polling interval in ms.
• Resolution: Output figure decimal places.

Tooling

Tests

To run tests:

npm run test
Copy

Documentation

To generate the documentation locally:

npm run docs
Copy

Linters

To run linters:

npm run lint
Copy

Formatters

To run formatters:

npm run format
Copy

Contributing

Please read this repository's Code of Conduct which outlines our collaboration standards and the Changelog for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit SemVer.

Bump2version is used to version and tag changes. For example:

bump2version patch
Copy

Contributors

• Joel Lefkowitz - Initial work

Remarks

Lots of love to the open source community!