Class OINOBenchmark`Abstract`

Static class for benchmarking functions.

Hierarchy (View Summary)

OINOBenchmark
- OINOMemoryBenchmark

Index

Constructors

Methods

endMetric getExceptions getMetric getMetrics reset setEnabled setInstance startMetric trackException trackMetric

Constructors

constructor

new OINOBenchmark(enabledModules?: string[]): OINOBenchmark
Create a new OINOBenchmark instance.
Parameters
- enabledModules: string[] = []
  array of those benchmarks that are enabled
Returns OINOBenchmark
- Defined in common/src/OINOBenchmark.ts:21

Methods

`Static`endMetric

endMetric(module: string, method: string, category?: string): 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
- Defined in common/src/OINOBenchmark.ts:78

`Static`getExceptions

getExceptions(): any[]
Get all tracked exceptions.

Returns any[]
- Defined in common/src/OINOBenchmark.ts:141

`Static`getMetric

getMetric(module: string, method: string): number
Get given benchmark data.
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
Returns number
- Defined in common/src/OINOBenchmark.ts:90

`Static`getMetrics

getMetrics(): Record<string, number>
Get all benchmark data.

Returns Record<string, number>
- Defined in common/src/OINOBenchmark.ts:99

`Static`reset

reset(): void
Reset benchmark data (but not what is enabled).

Returns void
- Defined in common/src/OINOBenchmark.ts:43

`Static`setEnabled

setEnabled(modules: string[]): void
Set benchmark names that are enabled.
Parameters
- modules: string[]
  array of those benchmarks that are enabled
Returns void
- Defined in common/src/OINOBenchmark.ts:52

`Static`setInstance

setInstance(instance: OINOBenchmark): void
Set active benchmarking instance.
Parameters
- instance: OINOBenchmark
  OINOBenchmark instance
Returns void
- Defined in common/src/OINOBenchmark.ts:31

`Static`startMetric

startMetric(module: string, method: string): void
Start benchmark timing.
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
Returns void
- Defined in common/src/OINOBenchmark.ts:66

`Static`trackException

trackException(
    module: string,
    method: string,
    category: string,
    name: string,
    message: string,
    stack: string,
): 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
- Defined in common/src/OINOBenchmark.ts:130

`Static`trackMetric

trackMetric(
    module: string,
    method: string,
    category: string,
    value: number,
): 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
- Defined in common/src/OINOBenchmark.ts:113