@augment-vir/common 13.2.4 → 13.4.0

package/dist/cjs/augments/map.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrSetFromMap = void 0;
+function getOrSetFromMap(map, key, createNewValueCallback) {
+    const mapKey = key;
+    if (map.has(mapKey)) {
+        return map.get(mapKey);
+    }
+    else {
+        const newValue = createNewValueCallback();
+        map.set(mapKey, newValue);
+        return newValue;
+    }
+}
+exports.getOrSetFromMap = getOrSetFromMap;

package/dist/cjs/augments/tuple.js

@@ -1,7 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLengthAtLeast = void 0;
+exports.assertLengthAtLeast = exports.isLengthAtLeast = void 0;
 function isLengthAtLeast(array, length) {
-    return array.length >= length;
+    try {
+        assertLengthAtLeast(array, length);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
 }
 exports.isLengthAtLeast = isLengthAtLeast;
+function assertLengthAtLeast(array, length, arrayName) {
+    if (array.length < length) {
+        throw new Error(arrayName
+            ? `'${arrayName}' is not at least '${length}' in length.`
+            : `Array is not at least '${length}' in length.`);
+    }
+}
+exports.assertLengthAtLeast = assertLengthAtLeast;

package/dist/cjs/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./augments/error"), exports);
 __exportStar(require("./augments/function"), exports);
 __exportStar(require("./augments/json"), exports);
 __exportStar(require("./augments/json-compatible"), exports);
+__exportStar(require("./augments/map"), exports);
 __exportStar(require("./augments/object/enum"), exports);
 __exportStar(require("./augments/object/filter-object"), exports);
 __exportStar(require("./augments/object/has-key"), exports);

package/dist/esm/augments/map.js

@@ -0,0 +1,11 @@
+export function getOrSetFromMap(map, key, createNewValueCallback) {
+    const mapKey = key;
+    if (map.has(mapKey)) {
+        return map.get(mapKey);
+    }
+    else {
+        const newValue = createNewValueCallback();
+        map.set(mapKey, newValue);
+        return newValue;
+    }
+}

package/dist/esm/augments/tuple.js

@@ -1,3 +1,16 @@
 export function isLengthAtLeast(array, length) {
-    return array.length >= length;
+    try {
+        assertLengthAtLeast(array, length);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+export function assertLengthAtLeast(array, length, arrayName) {
+    if (array.length < length) {
+        throw new Error(arrayName
+            ? `'${arrayName}' is not at least '${length}' in length.`
+            : `Array is not at least '${length}' in length.`);
+    }
 }

package/dist/esm/index.js

@@ -10,6 +10,7 @@ export * from './augments/error';
 export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
+export * from './augments/map';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/has-key';

package/dist/types/augments/map.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get a value from a map or call the callback and return its result and store the result in the
+ * map.
+ */
+export declare function getOrSetFromMap<MapKey extends object, MapValue>(map: WeakMap<MapKey, MapValue>, key: MapKey, createNewValueCallback: () => MapValue): MapValue;
+export declare function getOrSetFromMap<MapKey, MapValue>(map: Map<MapKey, MapValue>, key: MapKey, createNewValueCallback: () => MapValue): MapValue;

package/dist/types/augments/tuple.d.ts

@@ -5,4 +5,5 @@ export type AtLeastTuple<ArrayElementGeneric, LengthGeneric extends number> = re
     ...(ArrayElementGeneric | undefined)[]
 ];
 export declare function isLengthAtLeast<ArrayElementGeneric, LengthGeneric extends number>(array: ReadonlyArray<ArrayElementGeneric | undefined>, length: LengthGeneric): array is AtLeastTuple<ArrayElementGeneric, LengthGeneric>;
+export declare function assertLengthAtLeast<ArrayElementGeneric, LengthGeneric extends number>(array: ReadonlyArray<ArrayElementGeneric | undefined>, length: LengthGeneric, arrayName?: string): asserts array is AtLeastTuple<ArrayElementGeneric, LengthGeneric>;
 export {};

package/dist/types/index.d.ts

@@ -10,6 +10,7 @@ export * from './augments/error';
 export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
+export * from './augments/map';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/has-key';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "13.2.4",
+    "version": "13.4.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"