Class LeakDetector

Tracks object creation and destruction to detect memory leaks. Register types you want to monitor, then call created/destroyed.

Index

Constructors

Methods

created destroyed getStats getTypeStats logSummary register reset setThreshold startAutoCheck stopAutoCheck

Constructors

constructor

new LeakDetector(warningThreshold?: number): LeakDetector
Parameters
- warningThreshold: number = 100
Returns LeakDetector
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:20

Methods

created

created(name: string): void
Call when an object of a tracked type is created
Parameters
- name: string
Returns void
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:33

destroyed

destroyed(name: string): void
Call when an object of a tracked type is destroyed
Parameters
- name: string
Returns void
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:53

getStats

getStats(): Record<
string,
{ created: number; current: number; destroyed: number; peak: number },
>
Get stats for all tracked types

Returns Record<
string,
{ created: number; current: number; destroyed: number; peak: number },
>
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:61

getTypeStats

getTypeStats(name: string): TrackedType | undefined
Get stats for a specific type
Parameters
- name: string
Returns TrackedType | undefined
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:75

logSummary

logSummary(): void
Log a summary of all tracked types

Returns void
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:80

register

register(name: string): this
Register a type to track
Parameters
- name: string
Returns this
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:25

reset

reset(): void
Reset all tracking data

Returns void
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:112

setThreshold

setThreshold(threshold: number): void
Set the warning threshold
Parameters
- threshold: number
Returns void
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:117

startAutoCheck

startAutoCheck(intervalMs?: number): void
Start automatic periodic leak checks
Parameters
- intervalMs: number = 5000
Returns void
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:91

stopAutoCheck

stopAutoCheck(): void
Returns void
- Defined in packages/clik-engine/src/debug/LeakDetector.ts:104