@fluid-experimental/property-common 0.49.0 → 0.50.0-41540

package/lib/chronometer.js

@@ -0,0 +1,185 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * All the chronometer implementations (hrtime, window.performance, and date:
+ */
+const implementations = {
+    // Node implementation uses hrtime
+    node: {
+        name: "hrtime",
+        _startTime: 0,
+        _stopTime: undefined,
+        stop: () => { },
+        _start() {
+            this._startTime = process.hrtime();
+        },
+        _stop() {
+            this._stopTime = process.hrtime(this._startTime);
+        },
+        _elapsedSec() {
+            if (this._stopTime === undefined) {
+                this.stop();
+            }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return this._stopTime[0] + this._stopTime[1] / 1000000000;
+        },
+        _elapsedMilliSec() {
+            if (this._stopTime === undefined) {
+                this.stop();
+            }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return this._stopTime[0] * 1000 + this._stopTime[1] / 1000000;
+        },
+        _elapsedMicroSec() {
+            if (this._stopTime === undefined) {
+                this.stop();
+            }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return this._stopTime[0] * 1000000 + this._stopTime[1] / 1000;
+        },
+    },
+    // Browser implementation uses window.performance (if available):
+    performance: {
+        name: "window.performance",
+        _startTime: 0,
+        _stopTime: 0,
+        stop: () => { },
+        elapsedMilliSec: () => 0,
+        _start() {
+            this._startTime = window.performance.now();
+        },
+        _stop() {
+            this._stopTime = window.performance.now();
+        },
+        _elapsedSec() {
+            if (!this._stopTime) {
+                this.stop();
+            }
+            return this.elapsedMilliSec() / 1000;
+        },
+        _elapsedMilliSec() {
+            if (!this._stopTime) {
+                this.stop();
+            }
+            return this._stopTime - this._startTime;
+        },
+        _elapsedMicroSec() {
+            if (!this._stopTime) {
+                this.stop();
+            }
+            return this.elapsedMilliSec() * 1000;
+        },
+    },
+    // Fallback is Date implementation if none of the above is supported:
+    date: {
+        name: "date",
+        _startTime: new Date(),
+        _stopTime: undefined,
+        stop: () => { },
+        elapsedMilliSec: () => 0,
+        _start() {
+            this._startTime = new Date();
+        },
+        _stop() {
+            this._stopTime = new Date();
+        },
+        _elapsedSec() {
+            if (!this._stopTime) {
+                this.stop();
+            }
+            return this.elapsedMilliSec() / 1000;
+        },
+        _elapsedMilliSec() {
+            if (!this._stopTime) {
+                this.stop();
+            }
+            return this._stopTime.getTime() - this._startTime.getTime();
+        },
+        _elapsedMicroSec() {
+            if (!this._stopTime) {
+                this.stop();
+            }
+            return this.elapsedMilliSec() * 1000;
+        },
+    },
+};
+let impl;
+if (typeof process !== "undefined" && typeof process.hrtime !== "undefined") {
+    impl = implementations.node;
+}
+else if (typeof window !== "undefined" &&
+    typeof window.performance !== "undefined" &&
+    typeof window.performance.now !== "undefined") {
+    impl = implementations.performance;
+}
+else {
+    impl = implementations.date;
+}
+/**
+ * Creates and starts a new Chronometer.
+ */
+export class Chronometer {
+    constructor() {
+        this.start();
+    }
+    /**
+     * Sets the chronometer start time.
+     */
+    start() {
+        return impl._start.call(this);
+    }
+    /**
+     * Stops the chronometer. Stopped chronometers can be reused by calling {@link Chronometer.start} again.
+     *
+     * @returns The chronometer instance, so that callers can do this:
+     *   let elapsedMS = chrono.stop().elapsedMS();
+     */
+    stop() {
+        impl._stop.call(this);
+        return this;
+    }
+    /**
+     * @returns How many microseconds have elapsed between the last call to {@link Chronometer.start}
+     *   (or the chronometer creation), and {@link Chronometer.stop}. Implementations that are not precise
+     *   enough may return "elapsedMilliSec() * 1000". Measuring elapsed time causes the chronometer
+     *   to be stopped if required (if the chrono is not stopped when this method is called).
+     */
+    elapsedMicroSec() {
+        return impl._elapsedMicroSec.call(this);
+    }
+    /**
+     * @returns How many milliseconds have elapsed between the last call to {@link Chronometer.start}
+     *   (or the chronometer creation), and {@link Chronometer.stop}. Measuring elapsed time causes the
+     *   chronometer to be stopped if required (if the chrono is not stopped when this method is
+     *   called).
+     */
+    elapsedMilliSec() {
+        return impl._elapsedMilliSec.call(this);
+    }
+    /**
+     * @returns How many seconds have elapsed between the last call to {@link Chronometer.start}
+     *   (or the chronometer creation), and {@link Chronometer.stop}. Measuring elapsed time causes the
+     *   chronometer to be stopped if required (if the chrono is not stopped when this method is
+     *   called).
+     */
+    elapsedSec() {
+        return impl._elapsedSec.call(this);
+    }
+    /**
+     * A utility function to measure promise execution time.
+     * @param promiseFn - A function that returns a promise whose execution time is to be
+     *   measured.
+     * @returns A Promise that resolves with an object with properties:
+     *    - chrono A stopped chronometer instance from which to get the elapsed time,
+     *    - result The resolved result of the promise returned by promiseFn
+     */
+    static async timePromise(promiseFn) {
+        const chrono = new Chronometer();
+        const result = await promiseFn();
+        chrono.stop();
+        return { chrono, result };
+    }
+}
+//# sourceMappingURL=chronometer.js.map

package/lib/chronometer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chronometer.js","sourceRoot":"","sources":["../src/chronometer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH;;GAEG;AACH,MAAM,eAAe,GAAG;IACpB,kCAAkC;IAClC,IAAI,EAAE;QACF,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,CAAC;QACb,SAAS,EAAE,SAA8B;QACzC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC;QAEf,MAAM;YACF,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACvC,CAAC;QACD,KAAK;YACD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,WAAW;YACP,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;gBAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,oEAAoE;YACpE,OAAQ,IAAI,CAAC,SAAU,CAAC,CAAC,CAAY,GAAI,IAAI,CAAC,SAAU,CAAC,CAAC,CAAY,GAAG,UAAU,CAAC;QACxF,CAAC;QACD,gBAAgB;YACZ,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;gBAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,oEAAoE;YACpE,OAAO,IAAI,CAAC,SAAU,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,SAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QACpE,CAAC;QACD,gBAAgB;YACZ,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;gBAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,oEAAoE;YACpE,OAAO,IAAI,CAAC,SAAU,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC,SAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QACpE,CAAC;KACJ;IACD,iEAAiE;IACjE,WAAW,EAAE;QACT,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,CAAC;QACb,SAAS,EAAE,CAAC;QAEZ,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC;QACf,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC;QAExB,MAAM;YACF,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QAC/C,CAAC;QACD,KAAK;YACD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QAC9C,CAAC;QACD,WAAW;YACP,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,OAAO,IAAI,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;QACzC,CAAC;QACD,gBAAgB;YACZ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAC5C,CAAC;QACD,gBAAgB;YACZ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,OAAO,IAAI,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;QACzC,CAAC;KACJ;IACD,qEAAqE;IACrE,IAAI,EAAE;QACF,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,IAAI,IAAI,EAAE;QACtB,SAAS,EAAE,SAA6B;QACxC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC;QACf,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC;QAExB,MAAM;YACF,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QACjC,CAAC;QACD,KAAK;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAChC,CAAC;QACD,WAAW;YACP,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,OAAO,IAAI,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;QACzC,CAAC;QACD,gBAAgB;YACZ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,OAAQ,IAAI,CAAC,SAAkB,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC1E,CAAC;QACD,gBAAgB;YACZ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;aACf;YACD,OAAO,IAAI,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;QACzC,CAAC;KACJ;CACJ,CAAC;AAEF,IAAI,IAAoG,CAAC;AACzG,IAAI,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,WAAW,EAAE;IACzE,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;CAC/B;KAAM,IACH,OAAO,MAAM,KAAK,WAAW;IAC7B,OAAO,MAAM,CAAC,WAAW,KAAK,WAAW;IACzC,OAAO,MAAM,CAAC,WAAW,CAAC,GAAG,KAAK,WAAW,EAC/C;IACE,IAAI,GAAG,eAAe,CAAC,WAAW,CAAC;CACtC;KAAM;IACH,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;CAC/B;AAED;;GAEG;AAEH,MAAM,OAAO,WAAW;IACpB;QACI,IAAI,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,IAAI;QACA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,eAAe;QACX,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,eAAe;QACX,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,UAAU;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CAAI,SAA2B;QACnD,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC9B,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @fileoverview A chronometer implementation backed by a high resolution timer. Implementation\n *   falls back to milliseconds precision when high resolution timers are not supported.\n */\n\ndeclare let process: any;\n\n/**\n * All the chronometer implementations (hrtime, window.performance, and date:\n */\nconst implementations = {\n    // Node implementation uses hrtime\n    node: {\n        name: \"hrtime\",\n        _startTime: 0,\n        _stopTime: undefined as any[] | undefined,\n        stop: () => { },\n\n        _start() {\n            this._startTime = process.hrtime();\n        },\n        _stop() {\n            this._stopTime = process.hrtime(this._startTime);\n        },\n        _elapsedSec(): number {\n            if (this._stopTime === undefined) {\n                this.stop();\n            }\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            return (this._stopTime![0] as number) + (this._stopTime![1] as number) / 1000000000;\n        },\n        _elapsedMilliSec(): number {\n            if (this._stopTime === undefined) {\n                this.stop();\n            }\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            return this._stopTime![0] * 1000 + this._stopTime![1] / 1000000;\n        },\n        _elapsedMicroSec(): number {\n            if (this._stopTime === undefined) {\n                this.stop();\n            }\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            return this._stopTime![0] * 1000000 + this._stopTime![1] / 1000;\n        },\n    },\n    // Browser implementation uses window.performance (if available):\n    performance: {\n        name: \"window.performance\",\n        _startTime: 0,\n        _stopTime: 0,\n\n        stop: () => { },\n        elapsedMilliSec: () => 0,\n\n        _start() {\n            this._startTime = window.performance.now();\n        },\n        _stop() {\n            this._stopTime = window.performance.now();\n        },\n        _elapsedSec(): number {\n            if (!this._stopTime) {\n                this.stop();\n            }\n            return this.elapsedMilliSec() / 1000;\n        },\n        _elapsedMilliSec(): number {\n            if (!this._stopTime) {\n                this.stop();\n            }\n            return this._stopTime - this._startTime;\n        },\n        _elapsedMicroSec(): number {\n            if (!this._stopTime) {\n                this.stop();\n            }\n            return this.elapsedMilliSec() * 1000;\n        },\n    },\n    // Fallback is Date implementation if none of the above is supported:\n    date: {\n        name: \"date\",\n        _startTime: new Date(),\n        _stopTime: undefined as Date | undefined,\n        stop: () => { },\n        elapsedMilliSec: () => 0,\n\n        _start() {\n            this._startTime = new Date();\n        },\n        _stop() {\n            this._stopTime = new Date();\n        },\n        _elapsedSec(): number {\n            if (!this._stopTime) {\n                this.stop();\n            }\n            return this.elapsedMilliSec() / 1000;\n        },\n        _elapsedMilliSec(): number {\n            if (!this._stopTime) {\n                this.stop();\n            }\n            return (this._stopTime as Date).getTime() - this._startTime.getTime();\n        },\n        _elapsedMicroSec(): number {\n            if (!this._stopTime) {\n                this.stop();\n            }\n            return this.elapsedMilliSec() * 1000;\n        },\n    },\n};\n\nlet impl: typeof implementations.date | typeof implementations.node | typeof implementations.performance;\nif (typeof process !== \"undefined\" && typeof process.hrtime !== \"undefined\") {\n    impl = implementations.node;\n} else if (\n    typeof window !== \"undefined\" &&\n    typeof window.performance !== \"undefined\" &&\n    typeof window.performance.now !== \"undefined\"\n) {\n    impl = implementations.performance;\n} else {\n    impl = implementations.date;\n}\n\n/**\n * Creates and starts a new Chronometer.\n */\n\nexport class Chronometer {\n    constructor() {\n        this.start();\n    }\n\n    /**\n     * Sets the chronometer start time.\n     */\n    start() {\n        return impl._start.call(this);\n    }\n\n    /**\n     * Stops the chronometer. Stopped chronometers can be reused by calling {@link Chronometer.start} again.\n     *\n     * @returns The chronometer instance, so that callers can do this:\n     *   let elapsedMS = chrono.stop().elapsedMS();\n     */\n    stop(): Chronometer {\n        impl._stop.call(this);\n        return this;\n    }\n\n    /**\n     * @returns How many microseconds have elapsed between the last call to {@link Chronometer.start}\n     *   (or the chronometer creation), and {@link Chronometer.stop}. Implementations that are not precise\n     *   enough may return \"elapsedMilliSec() * 1000\". Measuring elapsed time causes the chronometer\n     *   to be stopped if required (if the chrono is not stopped when this method is called).\n     */\n    elapsedMicroSec(): number {\n        return impl._elapsedMicroSec.call(this);\n    }\n\n    /**\n     * @returns How many milliseconds have elapsed between the last call to {@link Chronometer.start}\n     *   (or the chronometer creation), and {@link Chronometer.stop}. Measuring elapsed time causes the\n     *   chronometer to be stopped if required (if the chrono is not stopped when this method is\n     *   called).\n     */\n    elapsedMilliSec(): number {\n        return impl._elapsedMilliSec.call(this);\n    }\n\n    /**\n     * @returns How many seconds have elapsed between the last call to {@link Chronometer.start}\n     *   (or the chronometer creation), and {@link Chronometer.stop}. Measuring elapsed time causes the\n     *   chronometer to be stopped if required (if the chrono is not stopped when this method is\n     *   called).\n     */\n    elapsedSec(): number {\n        return impl._elapsedSec.call(this);\n    }\n\n    /**\n     * A utility function to measure promise execution time.\n     * @param promiseFn - A function that returns a promise whose execution time is to be\n     *   measured.\n     * @returns A Promise that resolves with an object with properties:\n     *    - chrono A stopped chronometer instance from which to get the elapsed time,\n     *    - result The resolved result of the promise returned by promiseFn\n     */\n    static async timePromise<T>(promiseFn: () => Promise<T>): Promise<{ chrono: Chronometer, result: T }> {\n        const chrono = new Chronometer();\n        const result = await promiseFn();\n        chrono.stop();\n        return { chrono, result };\n    }\n}\n"]}

package/lib/consoleUtils.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Used to replace console.assert to make sure that it always throws an error, both in the browser and in Node
+ */
+export declare class ConsoleUtils {
+    /**
+     * Throws an error if the in_condition is false
+     * @param  in_condition - the condition we are testing: a boolean expression.
+     * @param  in_message - the error message that will be thrown if the condition is false.
+     */
+    static assert(condition: any, message: string | number): asserts condition;
+}
+//# sourceMappingURL=consoleUtils.d.ts.map

package/lib/consoleUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consoleUtils.d.ts","sourceRoot":"","sources":["../src/consoleUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,qBAAa,YAAY;IACrB;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,SAAS;CAK7E"}

package/lib/consoleUtils.js

@@ -0,0 +1,20 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Used to replace console.assert to make sure that it always throws an error, both in the browser and in Node
+ */
+export class ConsoleUtils {
+    /**
+     * Throws an error if the in_condition is false
+     * @param  in_condition - the condition we are testing: a boolean expression.
+     * @param  in_message - the error message that will be thrown if the condition is false.
+     */
+    static assert(condition, message) {
+        if (!condition) {
+            throw new Error(typeof message === "number" ? `0x${message.toString(16).padStart(3, "0")}` : message);
+        }
+    }
+}
+//# sourceMappingURL=consoleUtils.js.map

package/lib/consoleUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consoleUtils.js","sourceRoot":"","sources":["../src/consoleUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,OAAO,YAAY;IACrB;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,SAAc,EAAE,OAAwB;QAClD,IAAI,CAAE,SAAqB,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;SACzG;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Used to replace console.assert to make sure that it always throws an error, both in the browser and in Node\n */\nexport class ConsoleUtils { // eslint-disable-line @typescript-eslint/no-extraneous-class\n    /**\n     * Throws an error if the in_condition is false\n     * @param  in_condition - the condition we are testing: a boolean expression.\n     * @param  in_message - the error message that will be thrown if the condition is false.\n     */\n    static assert(condition: any, message: string | number): asserts condition {\n        if (!(condition as boolean)) {\n            throw new Error(typeof message === \"number\" ? `0x${message.toString(16).padStart(3, \"0\")}` : message);\n        }\n    }\n}\n"]}