@itwin/core-bentley 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/esm/JsonUtils.js

@@ -1,149 +1,149 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Json
- */
-/** Utility functions for converting from JSON objects, with default values.
- * @public
- */
-export var JsonUtils;
-(function (JsonUtils) {
-    /** Get a value as a boolean.
-     * @param json the input JSON object
-     * @param defaultVal default value if json cannot be converted to boolean
-     * @returns the value of json as a boolean, or default value
-     */
-    function asBool(json, defaultVal = false) {
-        return isNullOrUndefined(json) ? defaultVal : !!json;
-    }
-    JsonUtils.asBool = asBool;
-    /** Get a value as an integer.
-     * @param json the input JSON object
-     * @param defaultVal default value if json cannot be converted to integer
-     * @returns the value of json as an integer, or default value
-     */
-    function asInt(json, defaultVal = 0) {
-        return (typeof json === "number") ? Math.trunc(json) : defaultVal;
-    }
-    JsonUtils.asInt = asInt;
-    /** Get a value as a double.
-     * @param json the input JSON object
-     * @param defaultVal default value if json cannot be converted to double
-     * @returns the value of json as a double, or default value
-     */
-    function asDouble(json, defaultVal = 0) {
-        return (typeof json === "number") ? json : defaultVal;
-    }
-    JsonUtils.asDouble = asDouble;
-    /** Get a value as a string.
-     * @param json the input JSON object
-     * @param defaultVal default value if json cannot be converted to string
-     * @returns the value of json as a string, or default value
-     */
-    function asString(json, defaultVal = "") {
-        return isNullOrUndefined(json) ? defaultVal : json.toString();
-    }
-    JsonUtils.asString = asString;
-    /** Get a value as an array.
-     * @param json the input JSON object
-     * @returns the input JSON object if it is an array, otherwise undefined
-     */
-    function asArray(json) {
-        return Array.isArray(json) ? json : undefined;
-    }
-    JsonUtils.asArray = asArray;
-    /** Get a value as an object.
-     * @param json the input JSON object
-     * @returns the input JSON object if it is an object, otherwise undefined
-     */
-    function asObject(json) {
-        return "object" === typeof json ? json : undefined;
-    }
-    JsonUtils.asObject = asObject;
-    /** Set or remove a number on a json object, given a key name, a value, and a default value. Sets `json[key] = val` if val is *not* equal to the default,
-     * otherwise `delete json[key]`. This is used to omit values from JSON strings that are of known defaults.
-     * @param json the JSON object to affect
-     * @param key the name of the member to set or remove
-     * @param val the value to set
-     * @param defaultVal the default value.
-     */
-    function setOrRemoveNumber(json, key, val, defaultVal) {
-        if (val === defaultVal)
-            delete json[key];
-        else
-            json[key] = val;
-    }
-    JsonUtils.setOrRemoveNumber = setOrRemoveNumber;
-    /** Set or remove a boolean on a json object, given a key name, a value, and a default value. Sets `json[key] = val` if val is *not* equal to the default,
-     * otherwise `delete json[key]`. This is used to omit values from JSON strings that are of known defaults.
-     * @param json the JSON object to affect
-     * @param key the name of the member to set or remove
-     * @param val the value to set
-     * @param defaultVal the default value.
-     */
-    function setOrRemoveBoolean(json, key, val, defaultVal) {
-        if (val === defaultVal)
-            delete json[key];
-        else
-            json[key] = val;
-    }
-    JsonUtils.setOrRemoveBoolean = setOrRemoveBoolean;
-    /** Determine if a Javascript object is equivalent to `{}`.
-     * @param json The JSON object to test.
-     * @returns true if `json` is an Object with no keys.
-     */
-    function isEmptyObject(json) {
-        return "object" === typeof json && 0 === Object.keys(json).length;
-    }
-    JsonUtils.isEmptyObject = isEmptyObject;
-    /** Determine if the input is undefined or an empty Javascript object.
-     * @param json The JSON object to test.
-     * @returns true if `json` is undefined or is an Object with no keys (equivalent to `{}`).
-     */
-    function isEmptyObjectOrUndefined(json) {
-        return undefined === json || isEmptyObject(json);
-    }
-    JsonUtils.isEmptyObjectOrUndefined = isEmptyObjectOrUndefined;
-    function isNullOrUndefined(json) {
-        return null === json || undefined === json;
-    }
-    /** Determine if the input is a non-empty Javascript object.
-     * @param value The value to test.
-     * @returns true if `value` is an Object with at least one key.
-     */
-    function isNonEmptyObject(value) {
-        return !isEmptyObjectOrUndefined(value);
-    }
-    JsonUtils.isNonEmptyObject = isNonEmptyObject;
-    /**
-     * Convert the input object into a "pure" JavaScript object, with only instances of "object" or primitives in the returned value.
-     * Works recursively for object members, and over arrays entries. Calls "toJSON" on any members that implement it.
-     */
-    function toObject(val) {
-        if (typeof val === "boolean" || typeof val === "number" || typeof val === "string")
-            return val;
-        if (typeof val !== "object")
-            return undefined;
-        // See if the object has toJSON() function defined.
-        if (typeof val.toJSON !== "undefined")
-            return toObject(val.toJSON());
-        // if it's an array, convert each member.
-        if (Array.isArray(val)) {
-            const arr = new Array(val.length);
-            val.forEach((el, i) => arr[i] = toObject(el));
-            return arr;
-        }
-        // Convert each property
-        const out = {};
-        Object.getOwnPropertyNames(val).forEach((prop) => {
-            const transformVal = toObject(val[prop]);
-            if (transformVal !== undefined)
-                out[prop] = transformVal;
-        });
-        return out;
-    }
-    JsonUtils.toObject = toObject;
-})(JsonUtils || (JsonUtils = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Json
+ */
+/** Utility functions for converting from JSON objects, with default values.
+ * @public
+ */
+export var JsonUtils;
+(function (JsonUtils) {
+    /** Get a value as a boolean.
+     * @param json the input JSON object
+     * @param defaultVal default value if json cannot be converted to boolean
+     * @returns the value of json as a boolean, or default value
+     */
+    function asBool(json, defaultVal = false) {
+        return isNullOrUndefined(json) ? defaultVal : !!json;
+    }
+    JsonUtils.asBool = asBool;
+    /** Get a value as an integer.
+     * @param json the input JSON object
+     * @param defaultVal default value if json cannot be converted to integer
+     * @returns the value of json as an integer, or default value
+     */
+    function asInt(json, defaultVal = 0) {
+        return (typeof json === "number") ? Math.trunc(json) : defaultVal;
+    }
+    JsonUtils.asInt = asInt;
+    /** Get a value as a double.
+     * @param json the input JSON object
+     * @param defaultVal default value if json cannot be converted to double
+     * @returns the value of json as a double, or default value
+     */
+    function asDouble(json, defaultVal = 0) {
+        return (typeof json === "number") ? json : defaultVal;
+    }
+    JsonUtils.asDouble = asDouble;
+    /** Get a value as a string.
+     * @param json the input JSON object
+     * @param defaultVal default value if json cannot be converted to string
+     * @returns the value of json as a string, or default value
+     */
+    function asString(json, defaultVal = "") {
+        return isNullOrUndefined(json) ? defaultVal : json.toString();
+    }
+    JsonUtils.asString = asString;
+    /** Get a value as an array.
+     * @param json the input JSON object
+     * @returns the input JSON object if it is an array, otherwise undefined
+     */
+    function asArray(json) {
+        return Array.isArray(json) ? json : undefined;
+    }
+    JsonUtils.asArray = asArray;
+    /** Get a value as an object.
+     * @param json the input JSON object
+     * @returns the input JSON object if it is an object, otherwise undefined
+     */
+    function asObject(json) {
+        return "object" === typeof json ? json : undefined;
+    }
+    JsonUtils.asObject = asObject;
+    /** Set or remove a number on a json object, given a key name, a value, and a default value. Sets `json[key] = val` if val is *not* equal to the default,
+     * otherwise `delete json[key]`. This is used to omit values from JSON strings that are of known defaults.
+     * @param json the JSON object to affect
+     * @param key the name of the member to set or remove
+     * @param val the value to set
+     * @param defaultVal the default value.
+     */
+    function setOrRemoveNumber(json, key, val, defaultVal) {
+        if (val === defaultVal)
+            delete json[key];
+        else
+            json[key] = val;
+    }
+    JsonUtils.setOrRemoveNumber = setOrRemoveNumber;
+    /** Set or remove a boolean on a json object, given a key name, a value, and a default value. Sets `json[key] = val` if val is *not* equal to the default,
+     * otherwise `delete json[key]`. This is used to omit values from JSON strings that are of known defaults.
+     * @param json the JSON object to affect
+     * @param key the name of the member to set or remove
+     * @param val the value to set
+     * @param defaultVal the default value.
+     */
+    function setOrRemoveBoolean(json, key, val, defaultVal) {
+        if (val === defaultVal)
+            delete json[key];
+        else
+            json[key] = val;
+    }
+    JsonUtils.setOrRemoveBoolean = setOrRemoveBoolean;
+    /** Determine if a Javascript object is equivalent to `{}`.
+     * @param json The JSON object to test.
+     * @returns true if `json` is an Object with no keys.
+     */
+    function isEmptyObject(json) {
+        return "object" === typeof json && 0 === Object.keys(json).length;
+    }
+    JsonUtils.isEmptyObject = isEmptyObject;
+    /** Determine if the input is undefined or an empty Javascript object.
+     * @param json The JSON object to test.
+     * @returns true if `json` is undefined or is an Object with no keys (equivalent to `{}`).
+     */
+    function isEmptyObjectOrUndefined(json) {
+        return undefined === json || isEmptyObject(json);
+    }
+    JsonUtils.isEmptyObjectOrUndefined = isEmptyObjectOrUndefined;
+    function isNullOrUndefined(json) {
+        return null === json || undefined === json;
+    }
+    /** Determine if the input is a non-empty Javascript object.
+     * @param value The value to test.
+     * @returns true if `value` is an Object with at least one key.
+     */
+    function isNonEmptyObject(value) {
+        return !isEmptyObjectOrUndefined(value);
+    }
+    JsonUtils.isNonEmptyObject = isNonEmptyObject;
+    /**
+     * Convert the input object into a "pure" JavaScript object, with only instances of "object" or primitives in the returned value.
+     * Works recursively for object members, and over arrays entries. Calls "toJSON" on any members that implement it.
+     */
+    function toObject(val) {
+        if (typeof val === "boolean" || typeof val === "number" || typeof val === "string")
+            return val;
+        if (typeof val !== "object")
+            return undefined;
+        // See if the object has toJSON() function defined.
+        if (typeof val.toJSON !== "undefined")
+            return toObject(val.toJSON());
+        // if it's an array, convert each member.
+        if (Array.isArray(val)) {
+            const arr = new Array(val.length);
+            val.forEach((el, i) => arr[i] = toObject(el));
+            return arr;
+        }
+        // Convert each property
+        const out = {};
+        Object.getOwnPropertyNames(val).forEach((prop) => {
+            const transformVal = toObject(val[prop]);
+            if (transformVal !== undefined)
+                out[prop] = transformVal;
+        });
+        return out;
+    }
+    JsonUtils.toObject = toObject;
+})(JsonUtils || (JsonUtils = {}));
 //# sourceMappingURL=JsonUtils.js.map

package/lib/esm/LRUMap.d.ts

@@ -1,130 +1,130 @@
-/** @packageDocumentation
- * @module Collections
- */
-import { OrderedComparator } from "./Compare";
-/**
- * Derived from:
- * Licensed under MIT. Copyright (c) 2010 Rasmus Andersson <http://hunch.se/>
- * See README.md at https://github.com/rsms/js-lru for details.
- */
-/** An entry holds the key and value, and pointers to any older and newer entries.
- * @public
- */
-export declare class Entry<K, V> {
-    key: K;
-    value: V;
-    newer?: Entry<K, V>;
-    older?: Entry<K, V>;
-    constructor(key: K, value: V);
-}
-/** The interface that must be satisfied by the underlying container type used by a LRUCache.
- * Compatible with a [[Dictionary]] or a standard Map.
- * @public
- */
-export interface EntryContainer<K, V> {
-    readonly size: number;
-    clear(): void;
-    get(key: K): Entry<K, V> | undefined;
-    set(key: K, value: Entry<K, V>): void;
-    has(key: K): boolean;
-    delete(key: K): void;
-}
-/**
- * A mapping of a key/value pairs, where the size of the cache can be limited.
- *
- * When entries are inserted, if the cache is "full", the
- * least-recently-used (LRU) value is dropped. When entries are retrieved, they are moved to the front of the LRU list.
- *
- * Illustration of the design:
- *
- * ```
- *
- *       entry             entry             entry             entry
- *       ______            ______            ______            ______
- *      | head |.newer => |      |.newer => |      |.newer => | tail |
- *      |  A   |          |  B   |          |  C   |          |  D   |
- *      |______| <= older.|______| <= older.|______| <= older.|______|
- *
- *  removed  <--  <--  <--  <--  <--  <--  <--  <--  <--  <--  <--  added
- * ```
- * @public
- */
-export declare class LRUCache<K, V> {
-    private _container;
-    /** Current number of items */
-    size: number;
-    /** Maximum number of items this cache can hold */
-    limit: number;
-    /** Least recently-used entry. Invalidated when cache is modified. */
-    oldest?: Entry<K, V>;
-    /** Most recently-used entry. Invalidated when cache is modified. */
-    newest?: Entry<K, V>;
-    /**
-     * Construct a new LRUCache to hold up to `limit` entries.
-     */
-    constructor(limit: number, container: EntryContainer<K, V>);
-    private markEntryAsUsed;
-    /**  Replace all values in this cache with key-value pairs (2-element Arrays) from provided iterable. */
-    assign(entries: Iterable<[K, V]>): void;
-    /** Get and register recent use of <key>.
-     *  Returns the value associated with <key> or undefined if not in cache.
-     */
-    get(key: K): V | undefined;
-    /** Put <value> into the cache associated with <key>. Replaces any existing entry with the same key.
-     *  @returns `this`.
-     */
-    set(key: K, value: V): LRUCache<K, V>;
-    /**  Purge the least recently used (oldest) entry from the cache.
-     *  @returns The removed entry or undefined if the cache was empty.
-     */
-    shift(): [K, V] | undefined;
-    /** Access value for `key` without registering recent use. Useful if you do not
-     *  want to change the state of the cache, but only "peek" at it.
-     *  @returns The value associated with `key` if found, or undefined if not found.
-     */
-    find(key: K): V | undefined;
-    /** Check if there's a value for key in the cache without registering recent use. */
-    has(key: K): boolean;
-    /**  Remove entry `key` from cache and return its value.
-     *  @returns The removed value, or undefined if not found.
-     */
-    delete(key: K): V | undefined;
-    /**  Removes all entries */
-    clear(): void;
-    /** Returns an iterator over all keys, starting with the oldest. */
-    keys(): Iterator<K | undefined> | undefined;
-    /** Returns an iterator over all values, starting with the oldest. */
-    values(): Iterator<V | undefined> | undefined;
-    /** Returns an iterator over all entries, starting with the oldest. */
-    entries(): Iterator<[K, V] | undefined> | undefined;
-    /**  Call `fun` for each entry, starting with the oldest entry. */
-    forEach(fun: (value: V, key: K, m: LRUCache<K, V>) => void, thisObj?: any): void;
-    /** Returns a JSON (array) representation */
-    toJSON(): Array<{
-        key: K;
-        value: V;
-    }>;
-    /** Returns a String representation */
-    toString(): string;
-}
-/** A [[LRUCache]] using a standard Map as its internal storage.
- * @public
- */
-export declare class LRUMap<K, V> extends LRUCache<K, V> {
-    /**
-     * Construct a new LRUMap to hold up to `limit` entries.
-     */
-    constructor(limit: number);
-}
-/** A [[LRUCache]] using a [[Dictionary]] as its internal storage, permitting custom key comparison logic.
- * @public
- */
-export declare class LRUDictionary<K, V> extends LRUCache<K, V> {
-    /**
-     * Construct a new LRUDictionary to hold up to `limit` entries.
-     * @param limit The maximum number of entries permitted in the dictionary.
-     * @param compareKeys The function used to compare keys within the dictionary.
-     */
-    constructor(limit: number, compareKeys: OrderedComparator<K>);
-}
+/** @packageDocumentation
+ * @module Collections
+ */
+import { OrderedComparator } from "./Compare";
+/**
+ * Derived from:
+ * Licensed under MIT. Copyright (c) 2010 Rasmus Andersson <http://hunch.se/>
+ * See README.md at https://github.com/rsms/js-lru for details.
+ */
+/** An entry holds the key and value, and pointers to any older and newer entries.
+ * @public
+ */
+export declare class Entry<K, V> {
+    key: K;
+    value: V;
+    newer?: Entry<K, V>;
+    older?: Entry<K, V>;
+    constructor(key: K, value: V);
+}
+/** The interface that must be satisfied by the underlying container type used by a LRUCache.
+ * Compatible with a [[Dictionary]] or a standard Map.
+ * @public
+ */
+export interface EntryContainer<K, V> {
+    readonly size: number;
+    clear(): void;
+    get(key: K): Entry<K, V> | undefined;
+    set(key: K, value: Entry<K, V>): void;
+    has(key: K): boolean;
+    delete(key: K): void;
+}
+/**
+ * A mapping of a key/value pairs, where the size of the cache can be limited.
+ *
+ * When entries are inserted, if the cache is "full", the
+ * least-recently-used (LRU) value is dropped. When entries are retrieved, they are moved to the front of the LRU list.
+ *
+ * Illustration of the design:
+ *
+ * ```
+ *
+ *       entry             entry             entry             entry
+ *       ______            ______            ______            ______
+ *      | head |.newer => |      |.newer => |      |.newer => | tail |
+ *      |  A   |          |  B   |          |  C   |          |  D   |
+ *      |______| <= older.|______| <= older.|______| <= older.|______|
+ *
+ *  removed  <--  <--  <--  <--  <--  <--  <--  <--  <--  <--  <--  added
+ * ```
+ * @public
+ */
+export declare class LRUCache<K, V> {
+    private _container;
+    /** Current number of items */
+    size: number;
+    /** Maximum number of items this cache can hold */
+    limit: number;
+    /** Least recently-used entry. Invalidated when cache is modified. */
+    oldest?: Entry<K, V>;
+    /** Most recently-used entry. Invalidated when cache is modified. */
+    newest?: Entry<K, V>;
+    /**
+     * Construct a new LRUCache to hold up to `limit` entries.
+     */
+    constructor(limit: number, container: EntryContainer<K, V>);
+    private markEntryAsUsed;
+    /**  Replace all values in this cache with key-value pairs (2-element Arrays) from provided iterable. */
+    assign(entries: Iterable<[K, V]>): void;
+    /** Get and register recent use of <key>.
+     *  Returns the value associated with <key> or undefined if not in cache.
+     */
+    get(key: K): V | undefined;
+    /** Put <value> into the cache associated with <key>. Replaces any existing entry with the same key.
+     *  @returns `this`.
+     */
+    set(key: K, value: V): LRUCache<K, V>;
+    /**  Purge the least recently used (oldest) entry from the cache.
+     *  @returns The removed entry or undefined if the cache was empty.
+     */
+    shift(): [K, V] | undefined;
+    /** Access value for `key` without registering recent use. Useful if you do not
+     *  want to change the state of the cache, but only "peek" at it.
+     *  @returns The value associated with `key` if found, or undefined if not found.
+     */
+    find(key: K): V | undefined;
+    /** Check if there's a value for key in the cache without registering recent use. */
+    has(key: K): boolean;
+    /**  Remove entry `key` from cache and return its value.
+     *  @returns The removed value, or undefined if not found.
+     */
+    delete(key: K): V | undefined;
+    /**  Removes all entries */
+    clear(): void;
+    /** Returns an iterator over all keys, starting with the oldest. */
+    keys(): Iterator<K | undefined> | undefined;
+    /** Returns an iterator over all values, starting with the oldest. */
+    values(): Iterator<V | undefined> | undefined;
+    /** Returns an iterator over all entries, starting with the oldest. */
+    entries(): Iterator<[K, V] | undefined> | undefined;
+    /**  Call `fun` for each entry, starting with the oldest entry. */
+    forEach(fun: (value: V, key: K, m: LRUCache<K, V>) => void, thisObj?: any): void;
+    /** Returns a JSON (array) representation */
+    toJSON(): Array<{
+        key: K;
+        value: V;
+    }>;
+    /** Returns a String representation */
+    toString(): string;
+}
+/** A [[LRUCache]] using a standard Map as its internal storage.
+ * @public
+ */
+export declare class LRUMap<K, V> extends LRUCache<K, V> {
+    /**
+     * Construct a new LRUMap to hold up to `limit` entries.
+     */
+    constructor(limit: number);
+}
+/** A [[LRUCache]] using a [[Dictionary]] as its internal storage, permitting custom key comparison logic.
+ * @public
+ */
+export declare class LRUDictionary<K, V> extends LRUCache<K, V> {
+    /**
+     * Construct a new LRUDictionary to hold up to `limit` entries.
+     * @param limit The maximum number of entries permitted in the dictionary.
+     * @param compareKeys The function used to compare keys within the dictionary.
+     */
+    constructor(limit: number, compareKeys: OrderedComparator<K>);
+}
 //# sourceMappingURL=LRUMap.d.ts.map