3
0
Fork 0
mirror of https://gitea.com/actions/setup-python.git synced 2024-11-29 21:49:32 +01:00
setup-python/node_modules/jest-leak-detector/README.md
Danny McCormick 39c08a0eaa Initial pass
2019-06-26 21:12:00 -04:00

22 lines
570 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.isLeaked()); // true
// We destroy the only reference to the object.
reference = null;
// Reference is gone.
console.log(detector.isLeaked()); // false
```