Added test to ensure that release notes are parsed properly Updated to latest dependencies to fix security vulnerability Updated GH Actions Workflow to run test before updating tag Updated README.md to reflect proper whatsnew documentation.
23 lines
572 B
Markdown
23 lines
572 B
Markdown
# jest-leak-detector
|
|
|
|
Module for verifying whether an object has been garbage collected or not.
|
|
|
|
Internally creates a weak reference to the object, and forces garbage collection to happen. If the reference is gone, it meant no one else was pointing to the object.
|
|
|
|
## Example
|
|
|
|
```javascript
|
|
let reference = {};
|
|
|
|
const detector = new LeakDetector(reference);
|
|
|
|
// Reference is held in memory.
|
|
console.log(detector.isLeaking()); // true
|
|
|
|
// We destroy the only reference to the object.
|
|
reference = null;
|
|
|
|
// Reference is gone.
|
|
console.log(detector.isLeaking()); // false
|
|
```
|