function measureMemory
Unstable
Usage in Deno
import { measureMemory } from "node:vm";
measureMemory(options?: MeasureMemoryOptions): Promise<MemoryMeasurement>
<div class="alert alert-warning"><div><svg xmlns="http://www.w3.org/2000/svg" width="14" height="14"
viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"
stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 9v4" />
<path
d="M10.363 3.591l-8.106 13.534a1.914 1.914 0 0 0 1.636 2.871h16.214a1.914 1.914 0 0 0 1.636 -2.87l-8.106 -13.536a1.914 1.914 0 0 0 -3.274 0z" />
<path d="M12 16h.01" />
</svg>
Deno compatibility</div><div><p>
This is a non-functional stub.</p>
</div></div>
Measure the memory known to V8 and used by all contexts known to the current V8 isolate, or the main context.
The format of the object that the returned Promise may resolve with is specific to the V8 engine and may change from one version of V8 to the next.
The returned result is different from the statistics returned by v8.getHeapSpaceStatistics()
in that vm.measureMemory()
measure the
memory reachable by each V8 specific contexts in the current instance of
the V8 engine, while the result of v8.getHeapSpaceStatistics()
measure
the memory occupied by each heap space in the current V8 instance.
import vm from 'node:vm'; // Measure the memory used by the main context. vm.measureMemory({ mode: 'summary' }) // This is the same as vm.measureMemory() .then((result) => { // The current format is: // { // total: { // jsMemoryEstimate: 2418479, jsMemoryRange: [ 2418479, 2745799 ] // } // } console.log(result); }); const context = vm.createContext({ a: 1 }); vm.measureMemory({ mode: 'detailed', execution: 'eager' }) .then((result) => { // Reference the context here so that it won't be GC'ed // until the measurement is complete. console.log(context.a); // { // total: { // jsMemoryEstimate: 2574732, // jsMemoryRange: [ 2574732, 2904372 ] // }, // current: { // jsMemoryEstimate: 2438996, // jsMemoryRange: [ 2438996, 2768636 ] // }, // other: [ // { // jsMemoryEstimate: 135736, // jsMemoryRange: [ 135736, 465376 ] // } // ] // } console.log(result); });
optional
options: MeasureMemoryOptions
Promise<MemoryMeasurement>