@oino-ts/types 0.8.2 → 0.9.0

package/common/src/OINOBenchmark.d.ts

@@ -2,11 +2,23 @@
  * Static class for benchmarking functions.
  *
  */
-export declare class OINOBenchmark {
-    private static _benchmarkCount;
-    private static _benchmarkData;
-    private static _benchmarkEnabled;
-    private static _benchmarkStart;
+export declare abstract class OINOBenchmark {
+    protected static _instance: OINOBenchmark;
+    protected static _enabled: Record<string, boolean>;
+    /**
+     * Create a new OINOBenchmark instance.
+     *
+     * @param enabledModules array of those benchmarks that are enabled
+     */
+    constructor(enabledModules?: string[]);
+    /**
+     * Set active benchmarking instance.
+     *
+     * @param instance OINOBenchmark instance
+     *
+     */
+    static setInstance(instance: OINOBenchmark): void;
+    protected abstract _reset(): void;
     /**
      * Reset benchmark data (but not what is enabled).
      *
@@ -15,9 +27,10 @@ export declare class OINOBenchmark {
     /**
      *  Set benchmark names that are enabled.
      *
-     *  @param module array of those benchmarks that are enabled
+     *  @param modules array of those benchmarks that are enabled
      */
-    static setEnabled(module: string[]): void;
+    static setEnabled(modules: string[]): void;
+    protected abstract _start(module: string, method: string): void;
     /**
      * Start benchmark timing.
      *
@@ -25,6 +38,7 @@ export declare class OINOBenchmark {
      * @param method of the benchmark
      */
     static start(module: string, method: string): void;
+    protected abstract _end(module: string, method: string, category?: string): number;
     /**
      * Complete benchmark timing
      *
@@ -33,6 +47,7 @@ export declare class OINOBenchmark {
      * @param category optional subcategory of the benchmark
      */
     static end(module: string, method: string, category?: string): number;
+    protected abstract _get(module: string, method: string): number;
     /**
      * Get given benchmark data.
      *
@@ -41,9 +56,53 @@ export declare class OINOBenchmark {
      *
      */
     static get(module: string, method: string): number;
+    protected abstract _getAll(): Record<string, number>;
+    /**
+     * Get all benchmark data.
+     *
+     */
+    static getAll(): Record<string, number>;
+}
+/**
+ * OINOMemoryBenchmark is a memory-based benchmark implementation.
+ * It stores the benchmark data in memory and allows to reset, start, end and get benchmark data.
+ *
+ */
+export declare class OINOMemoryBenchmark extends OINOBenchmark {
+    private _benchmarkCount;
+    private _benchmarkData;
+    private _benchmarkStart;
+    /**
+     * Reset benchmark data (but not what is enabled).
+     *
+     */
+    protected _reset(): void;
+    /**
+     * Start benchmark timing.
+     *
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    protected _start(module: string, method: string): void;
+    /**
+     * Complete benchmark timing
+     *
+     * @param module of the benchmark
+     * @param method of the benchmark
+     * @param category optional subcategory of the benchmark
+     */
+    protected _end(module: string, method: string, category?: string): number;
+    /**
+     * Get given benchmark data.
+     *
+     * @param module of the benchmark
+     * @param method of the benchmark
+     *
+     */
+    protected _get(module: string, method: string): number;
     /**
      * Get all benchmark data.
      *
      */
-    static getAll(): number;
+    protected _getAll(): Record<string, number>;
 }

package/common/src/OINOLog.d.ts

@@ -51,12 +51,12 @@ export declare abstract class OINOLog {
      */
     protected static _log(level: OINOLogLevel, levelStr: string, domain: string, channel: string, method: string, message: string, data?: any): void;
     /**
-     * Set active logger and log level.
+     * Set active logger instance.
      *
-     * @param logger logger instance
+     * @param instance OINOLog instance
      *
      */
-    static setLogger(logger: OINOLog): void;
+    static setInstance(instance: OINOLog): void;
     /**
      * Set log level for given combination of domain/channel/method. Not defining dimension(s) means they match any value.
      * Multiple settings can be combined to set different logging accuracy specifically

package/common/src/index.d.ts

@@ -1,4 +1,4 @@
-export { OINOBenchmark } from "./OINOBenchmark.js";
+export { OINOBenchmark, OINOMemoryBenchmark } from "./OINOBenchmark.js";
 export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
 export { OINOResult, OINOHttpResult } from "./OINOResult.js";
 export { OINOStr } from "./OINOStr.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "OINO TS package for types.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",