Class Profiler

services

clear

• clear(): void

  Resets the profiler by clearing the store, total time and memory consumption. This method is useful for starting a new profiling session.

  Returns void

disable

• disable(): void

  Disables the profiler. Sets the active state to false, preventing further profiling.

  Returns void

enable

• enable(): void

  Enables the profiler. Sets the active state to true, allowing profiling to occur.

  Returns void

getAll

• getAll(): ProfilerEntry<any>[]

  Retrieves all profiler entries stored in the profiler.

  Returns ProfilerEntry<any>[]

  • An array of profiler entries

getLast

• getLast(): ProfilerEntry<any> | undefined

  Retrieves the last profiler entry stored in the profiler.

  Returns ProfilerEntry<any> | undefined

  • The last profiler entry or undefined if no entries exist

getTotal

• getTotal(): { mem: number; time: number }

  Retrieves the total time and memory consumption recorded by the profiler.

  Returns { mem: number; time: number }

  • An object containing total time and memory usage

run

• run<T>(fn: () => T, meta?: Record<string, any>): T

  Runs a synchronous function and profiles its execution time and memory usage. If the profiler is not active, it simply executes the function without profiling.

  Type Parameters

  • T

  Parameters

  • fn: () => T

    Function to be executed and profiled

  • meta: Record<string, any> = {}

    Metadata to be associated with the profiling entry

  Returns T

  • The result of the executed function

runAsync

• runAsync<T>(fn: () => Promise<T>, meta?: Record<string, any>): Promise<T>

  Runs an asynchronous function and profiles its execution time and memory usage. If the profiler is not active, it simply executes the function without profiling.

  Type Parameters

  • T

  Parameters

  • fn: () => Promise<T>

    Asynchronous function to be executed and profiled

  • meta: Record<string, any> = {}

    Metadata to be associated with the profiling entry

  Returns Promise<T>

  • A promise that resolves to the result of the executed function

StaticgetInstance

• getInstance(enable?: boolean): Profiler

  Returns the singleton instance of the Profiler class. If the instance does not exist, it creates a new one.

  Parameters

  • Optionalenable: boolean

    Optional parameter to enable the profiler upon instantiation

  Returns Profiler

  • Singleton Profiler instance