Class OINOMemoryBenchmark

OINOMemoryBenchmark is a memory-based benchmark implementation. It stores the benchmark data in memory and allows to reset, start, end and get benchmark data. In case of recursively/iteratively starting a benchmark, it will honor the first start and ignore the rest. *

Hierarchy (view full)

Constructors

constructor

Methods

endMetric getExceptions getMetric getMetrics reset setEnabled setInstance startMetric trackException trackMetric

Constructors

constructor

Methods

Static endMetric

  • endMetric(module, method, category?): void

  • Complete benchmark timing

    Parameters

    • module: string

      of the benchmark

    • method: string

      of the benchmark

    • category: string = "OK"

      optional subcategory of the benchmark

    Returns void

Static getExceptions

Static getMetric

Static getMetrics

Static reset

Static setEnabled

Static setInstance

Static startMetric

Static trackException

  • trackException(module, method, category, name, message, stack): void

  • Track an exception

    Parameters

    • module: string

      of the benchmark

    • method: string

      of the benchmark

    • category: string

      optional subcategory of the benchmark

    • name: string

      of the exception

    • message: string

      of the exception

    • stack: string

      trace of the exception

    Returns void

Static trackMetric

  • trackMetric(module, method, category, value): void

  • Track a metric value

    Parameters

    • module: string

      of the metric

    • method: string

      of the metric

    • category: string

      optional subcategory of the metric

    • value: number

      of the metric

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorendMetricgetExceptionsgetMetricgetMetricsresetsetEnabledsetInstancestartMetrictrackExceptiontrackMetric