Profiler

Index

Properties

• heapStats
• profilesRunning
• samplingInterval

Methods

• getMemoryProfile
• startProfiling
• stopProfiling
• takeHeapSnapshot

Properties

publicstaticreadonlyheapStats

heapStats: IHeapStats

publicstaticreadonlyprofilesRunning

profilesRunning: number

publicstaticsamplingInterval

samplingInterval: number

Sampling interval in microseconds. Defaults to 100.

Methods

publicstaticgetMemoryProfile

• getMemoryProfile(): void

publicstaticstartProfiling

• startProfiling(profileName?: string): void

• Starts a new profile with the specified name.

  Remarks

  This can throw an error if starting the profile fails.

publicstaticstopProfiling

• stopProfiling(profileName?: string): IProfile

• Stops the profile with the specified name.

publicstatictakeHeapSnapshot

• takeHeapSnapshot(): Promise<string>

• Takes a heap snapshot. For more information see https://nodejs.org/en/docs/guides/diagnostics/memory/using-heap-snapshot/

  Remarks

  The return value is a promise that once resolved contains the JSON string of the serialized heap.