A simple NodeJS memory usage poller.
Source | Shields |
---|---|
Project | |
Health | |
Publishers | |
Repository | |
Activity |
npm i mempoll
import { poll } from "mempoll";
poll();
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 │
└────────────────────┴────────┘
import { Worker } from "worker_threads";
const poll: (interval: number = 1000, resolution: number = 3) => Worker;
- Interval: Polling interval in ms.
- Resolution: Output figure decimal places.
To run tests:
nps test
This repository's documentation is hosted on Read the Docs.
To generate the documentation locally:
quickdocs
To run linters:
nps lint
To run formatters:
nps format
This repository uses GitHub Actions to lint and test each commit. Each commit should be formatted and its corresponding documentation should be updated.
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
Please read this repository's changelog for details on changes that have been made.
Please read this repository's guidelines on contributing for details on the process for submitting pull requests. Moreover, our code of conduct declares our collaboration standards.
- Joel Lefkowitz - Initial work
Lots of love to the open source community!