README

memory-diff

A simple object that enables recording heap memory that is consumed by some function/code and format the result.

Install

npm install --save memory-diff

Usage

Creation

const memoryDiffFn = require('memory-diff');
const memoryDiff = memoryDiffFn('test-function');

.start()

starts recording heap memory size.

memoryDiff.start();

.stop()

stops recording heap memory size.

memoryDiff.stop();

.megabytes()

return the MB part in the recorded memory

console.log(memoryDiff.megabytes()); // 3

.kilobytes()

return the KB part in the recorded memory

console.log(memoryDiff.kilobytes()); // 7

.bytes()

return the Bytes part in the recorded memory

console.log(memoryDiff.bytes()); // 588

.isRunning()

checks if the memoryDiff is running and hasn't been stopped

console.log(memoryDiff.isRunning()); // false

.isStopped()

checks if the memoryDiff has been stopped

console.log(memoryDiff.isStopped()); // true

.format(template)

formats the recorded memory using a custom or default template. The function replaces the memory size fractions placeholders in a string. Placeholders are:

%label for the memoryDiff label.
%mb for Megabytes.
%kb for Kilobytes.
%b for Bytes.

// using the default template
console.log(memoryDiff.format()); // memory-test: 3 MB, 7 KB, 588 bytes

// using a custom template
const custom = '%label [%mb MB - %kb KB - %b B ]';
console.log(memoryDiff.format(custom)); // memory-test [3 MB - 7 KB - 588 B ]

.clear()

clears the memoryDiff values. Can be started again to record new values.

memoryDiff.clear();
console.log(memoryDiff.megabytes()); // null

Example

const test = () => {
  memoryDiff.start();
  const arr = Array(1000000).fill('test');
  memoryDiff.stop();
};
test();
console.log(memoryDiff.format()); // 'test: 8 MB, 115 KB, 56 bytes'

Build

grunt build

License

The MIT License. Full License is here

Usage no npm install needed!