@itwin/core-common 3.6.0-dev.5 → 3.6.0-dev.51

package/lib/cjs/FeatureGates.d.ts

@@ -1,32 +0,0 @@
-import { BeEvent } from "@itwin/core-bentley";
-/** @internal */
-export declare type GateValue = number | boolean | string | undefined;
-/** A set of "gates" that can enable or disable features at runtime.
- * @internal
- */
-export declare class FeatureGates {
-    /** Event raised every time any feature changes. */
-    onChanged: BeEvent<(feature: string, val: GateValue) => void>;
-    /** A map of the current set of features. */
-    readonly gates: Map<string, GateValue>;
-    /** Get the value of a potentially gated feature.
-     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *       Feature names are case-sensitive.
-     * @param defaultVal Optionally, value to return if feature is undefined.
-     */
-    check(feature: string, defaultVal?: GateValue): GateValue;
-    /** Gate access to a feature.
-     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *  Feature names are case-sensitive.
-     * @param val Value to set. If undefined, feature is deleted.
-     */
-    setGate(feature: string, val: GateValue): void;
-    /** Register a listener to be called whenever the value of a specific gate changes.
-     * @param feature The name of the feature to monitor
-     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
-     * @returns A function that may be called to remove the listener.
-     * @note Use [[onChanged]] to listen to changes for *all* gates.
-     */
-    addMonitor(feature: string, monitor: (val: GateValue) => void): () => void;
-}
-//# sourceMappingURL=FeatureGates.d.ts.map

package/lib/cjs/FeatureGates.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FeatureGates.d.ts","sourceRoot":"","sources":["../../src/FeatureGates.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,gBAAgB;AAChB,oBAAY,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9D;;GAEG;AACH,qBAAa,YAAY;IACvB,mDAAmD;IAC5C,SAAS,oBAAyB,MAAM,OAAO,SAAS,KAAK,IAAI,EAAI;IAE5E,4CAA4C;IAC5C,SAAgB,KAAK,yBAAgC;IAErD;;;;OAIG;IACI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,SAAS,GAAG,SAAS;IAKhE;;;;OAIG;IACI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI;IAWrD;;;;;OAKG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,GAAG,MAAM,IAAI;CAMlF"}

package/lib/cjs/FeatureGates.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeatureGates = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-const core_bentley_1 = require("@itwin/core-bentley");
-/** A set of "gates" that can enable or disable features at runtime.
- * @internal
- */
-class FeatureGates {
-    constructor() {
-        /** Event raised every time any feature changes. */
-        this.onChanged = new core_bentley_1.BeEvent();
-        /** A map of the current set of features. */
-        this.gates = new Map();
-    }
-    /** Get the value of a potentially gated feature.
-     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *       Feature names are case-sensitive.
-     * @param defaultVal Optionally, value to return if feature is undefined.
-     */
-    check(feature, defaultVal) {
-        const val = this.gates.get(feature);
-        return val === undefined ? defaultVal : val;
-    }
-    /** Gate access to a feature.
-     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *  Feature names are case-sensitive.
-     * @param val Value to set. If undefined, feature is deleted.
-     */
-    setGate(feature, val) {
-        if (feature.length === 0)
-            return;
-        if (val === undefined)
-            this.gates.delete(feature);
-        else
-            this.gates.set(feature, val);
-        this.onChanged.raiseEvent(feature, val);
-    }
-    /** Register a listener to be called whenever the value of a specific gate changes.
-     * @param feature The name of the feature to monitor
-     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
-     * @returns A function that may be called to remove the listener.
-     * @note Use [[onChanged]] to listen to changes for *all* gates.
-     */
-    addMonitor(feature, monitor) {
-        return this.onChanged.addListener((changed, val) => {
-            if (changed === feature)
-                monitor(val);
-        });
-    }
-}
-exports.FeatureGates = FeatureGates;
-//# sourceMappingURL=FeatureGates.js.map

package/lib/cjs/FeatureGates.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FeatureGates.js","sourceRoot":"","sources":["../../src/FeatureGates.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,sDAA8C;AAK9C;;GAEG;AACH,MAAa,YAAY;IAAzB;QACE,mDAAmD;QAC5C,cAAS,GAAG,IAAI,sBAAO,EAA6C,CAAC;QAE5E,4CAA4C;QAC5B,UAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IAwCvD,CAAC;IAtCC;;;;OAIG;IACI,KAAK,CAAC,OAAe,EAAE,UAAsB;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,OAAe,EAAE,GAAc;QAC5C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YACtB,OAAO;QACT,IAAI,GAAG,KAAK,SAAS;YACnB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;YAE3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAE/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,OAAe,EAAE,OAAiC;QAClE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;YACjD,IAAI,OAAO,KAAK,OAAO;gBACrB,OAAO,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA7CD,oCA6CC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\n\r\n/** @internal */\r\nexport type GateValue = number | boolean | string | undefined;\r\n\r\n/** A set of \"gates\" that can enable or disable features at runtime.\r\n * @internal\r\n */\r\nexport class FeatureGates {\r\n  /** Event raised every time any feature changes. */\r\n  public onChanged = new BeEvent<(feature: string, val: GateValue) => void>();\r\n\r\n  /** A map of the current set of features. */\r\n  public readonly gates = new Map<string, GateValue>();\r\n\r\n  /** Get the value of a potentially gated feature.\r\n   * @param feature The name of the feature to check. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\r\n   *       Feature names are case-sensitive.\r\n   * @param defaultVal Optionally, value to return if feature is undefined.\r\n   */\r\n  public check(feature: string, defaultVal?: GateValue): GateValue {\r\n    const val = this.gates.get(feature);\r\n    return val === undefined ? defaultVal : val;\r\n  }\r\n\r\n  /** Gate access to a feature.\r\n   * @param feature The name of the feature to gate. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\r\n   *  Feature names are case-sensitive.\r\n   * @param val Value to set. If undefined, feature is deleted.\r\n   */\r\n  public setGate(feature: string, val: GateValue): void {\r\n    if (feature.length === 0)\r\n      return;\r\n    if (val === undefined)\r\n      this.gates.delete(feature);\r\n    else\r\n      this.gates.set(feature, val);\r\n\r\n    this.onChanged.raiseEvent(feature, val);\r\n  }\r\n\r\n  /** Register a listener to be called whenever the value of a specific gate changes.\r\n   * @param feature The name of the feature to monitor\r\n   * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).\r\n   * @returns A function that may be called to remove the listener.\r\n   * @note Use [[onChanged]] to listen to changes for *all* gates.\r\n   */\r\n  public addMonitor(feature: string, monitor: (val: GateValue) => void): () => void {\r\n    return this.onChanged.addListener((changed, val) => {\r\n      if (changed === feature)\r\n        monitor(val);\r\n    });\r\n  }\r\n}\r\n"]}

package/lib/esm/FeatureGates.d.ts

@@ -1,32 +0,0 @@
-import { BeEvent } from "@itwin/core-bentley";
-/** @internal */
-export declare type GateValue = number | boolean | string | undefined;
-/** A set of "gates" that can enable or disable features at runtime.
- * @internal
- */
-export declare class FeatureGates {
-    /** Event raised every time any feature changes. */
-    onChanged: BeEvent<(feature: string, val: GateValue) => void>;
-    /** A map of the current set of features. */
-    readonly gates: Map<string, GateValue>;
-    /** Get the value of a potentially gated feature.
-     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *       Feature names are case-sensitive.
-     * @param defaultVal Optionally, value to return if feature is undefined.
-     */
-    check(feature: string, defaultVal?: GateValue): GateValue;
-    /** Gate access to a feature.
-     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *  Feature names are case-sensitive.
-     * @param val Value to set. If undefined, feature is deleted.
-     */
-    setGate(feature: string, val: GateValue): void;
-    /** Register a listener to be called whenever the value of a specific gate changes.
-     * @param feature The name of the feature to monitor
-     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
-     * @returns A function that may be called to remove the listener.
-     * @note Use [[onChanged]] to listen to changes for *all* gates.
-     */
-    addMonitor(feature: string, monitor: (val: GateValue) => void): () => void;
-}
-//# sourceMappingURL=FeatureGates.d.ts.map

package/lib/esm/FeatureGates.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FeatureGates.d.ts","sourceRoot":"","sources":["../../src/FeatureGates.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,gBAAgB;AAChB,oBAAY,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9D;;GAEG;AACH,qBAAa,YAAY;IACvB,mDAAmD;IAC5C,SAAS,oBAAyB,MAAM,OAAO,SAAS,KAAK,IAAI,EAAI;IAE5E,4CAA4C;IAC5C,SAAgB,KAAK,yBAAgC;IAErD;;;;OAIG;IACI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,SAAS,GAAG,SAAS;IAKhE;;;;OAIG;IACI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI;IAWrD;;;;;OAKG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,GAAG,MAAM,IAAI;CAMlF"}

package/lib/esm/FeatureGates.js

@@ -1,52 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-import { BeEvent } from "@itwin/core-bentley";
-/** A set of "gates" that can enable or disable features at runtime.
- * @internal
- */
-export class FeatureGates {
-    constructor() {
-        /** Event raised every time any feature changes. */
-        this.onChanged = new BeEvent();
-        /** A map of the current set of features. */
-        this.gates = new Map();
-    }
-    /** Get the value of a potentially gated feature.
-     * @param feature The name of the feature to check. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *       Feature names are case-sensitive.
-     * @param defaultVal Optionally, value to return if feature is undefined.
-     */
-    check(feature, defaultVal) {
-        const val = this.gates.get(feature);
-        return val === undefined ? defaultVal : val;
-    }
-    /** Gate access to a feature.
-     * @param feature The name of the feature to gate. May be a "path" of period-separated feature sub-groups (e.g. "feature1.groupA.showMe").
-     *  Feature names are case-sensitive.
-     * @param val Value to set. If undefined, feature is deleted.
-     */
-    setGate(feature, val) {
-        if (feature.length === 0)
-            return;
-        if (val === undefined)
-            this.gates.delete(feature);
-        else
-            this.gates.set(feature, val);
-        this.onChanged.raiseEvent(feature, val);
-    }
-    /** Register a listener to be called whenever the value of a specific gate changes.
-     * @param feature The name of the feature to monitor
-     * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).
-     * @returns A function that may be called to remove the listener.
-     * @note Use [[onChanged]] to listen to changes for *all* gates.
-     */
-    addMonitor(feature, monitor) {
-        return this.onChanged.addListener((changed, val) => {
-            if (changed === feature)
-                monitor(val);
-        });
-    }
-}
-//# sourceMappingURL=FeatureGates.js.map

package/lib/esm/FeatureGates.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FeatureGates.js","sourceRoot":"","sources":["../../src/FeatureGates.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAK9C;;GAEG;AACH,MAAM,OAAO,YAAY;IAAzB;QACE,mDAAmD;QAC5C,cAAS,GAAG,IAAI,OAAO,EAA6C,CAAC;QAE5E,4CAA4C;QAC5B,UAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IAwCvD,CAAC;IAtCC;;;;OAIG;IACI,KAAK,CAAC,OAAe,EAAE,UAAsB;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,OAAe,EAAE,GAAc;QAC5C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YACtB,OAAO;QACT,IAAI,GAAG,KAAK,SAAS;YACnB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;YAE3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAE/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,OAAe,EAAE,OAAiC;QAClE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;YACjD,IAAI,OAAO,KAAK,OAAO;gBACrB,OAAO,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\n\r\n/** @internal */\r\nexport type GateValue = number | boolean | string | undefined;\r\n\r\n/** A set of \"gates\" that can enable or disable features at runtime.\r\n * @internal\r\n */\r\nexport class FeatureGates {\r\n  /** Event raised every time any feature changes. */\r\n  public onChanged = new BeEvent<(feature: string, val: GateValue) => void>();\r\n\r\n  /** A map of the current set of features. */\r\n  public readonly gates = new Map<string, GateValue>();\r\n\r\n  /** Get the value of a potentially gated feature.\r\n   * @param feature The name of the feature to check. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\r\n   *       Feature names are case-sensitive.\r\n   * @param defaultVal Optionally, value to return if feature is undefined.\r\n   */\r\n  public check(feature: string, defaultVal?: GateValue): GateValue {\r\n    const val = this.gates.get(feature);\r\n    return val === undefined ? defaultVal : val;\r\n  }\r\n\r\n  /** Gate access to a feature.\r\n   * @param feature The name of the feature to gate. May be a \"path\" of period-separated feature sub-groups (e.g. \"feature1.groupA.showMe\").\r\n   *  Feature names are case-sensitive.\r\n   * @param val Value to set. If undefined, feature is deleted.\r\n   */\r\n  public setGate(feature: string, val: GateValue): void {\r\n    if (feature.length === 0)\r\n      return;\r\n    if (val === undefined)\r\n      this.gates.delete(feature);\r\n    else\r\n      this.gates.set(feature, val);\r\n\r\n    this.onChanged.raiseEvent(feature, val);\r\n  }\r\n\r\n  /** Register a listener to be called whenever the value of a specific gate changes.\r\n   * @param feature The name of the feature to monitor\r\n   * @param monitor The listener to call when `feature` changes. Receives a single argument holding the new value of the feature (may be undefined).\r\n   * @returns A function that may be called to remove the listener.\r\n   * @note Use [[onChanged]] to listen to changes for *all* gates.\r\n   */\r\n  public addMonitor(feature: string, monitor: (val: GateValue) => void): () => void {\r\n    return this.onChanged.addListener((changed, val) => {\r\n      if (changed === feature)\r\n        monitor(val);\r\n    });\r\n  }\r\n}\r\n"]}