@augment-vir/common 30.0.0 → 30.0.1

package/dist/augments/type/writable.d.ts

@@ -1,3 +1,10 @@
 import type { Writable } from 'type-fest';
 export type { Writable, WritableDeep } from 'type-fest';
+/**
+ * This function does nothing but return the input as a writable typed version of itself.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function makeWritable<T>(input: T): Writable<T>;

package/dist/augments/type/writable.js

@@ -1,3 +1,10 @@
+/**
+ * This function does nothing but return the input as a writable typed version of itself.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function makeWritable(input) {
     return input;
 }

package/dist/index.d.ts

@@ -8,15 +8,14 @@ export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/repeat-array.js';
 export * from './augments/array/shuffle-array.js';
 export * from './augments/array/string-array.js';
-export * from './augments/boolean/if-truthy.js';
 export * from './augments/core-exports.js';
 export * from './augments/enum/enum-value-check.js';
 export * from './augments/error/combine-errors.js';
-export * from './augments/file/esm-path.js';
 export * from './augments/function/call-asynchronously.js';
 export * from './augments/function/call-with-retries.js';
 export * from './augments/function/debounce.js';
 export * from './augments/function/execution-duration.js';
+export * from './augments/function/if-truthy.js';
 export * from './augments/function/wrap-in-try.js';
 export * from './augments/json/append-json.js';
 export * from './augments/json/copy-through-json.js';
@@ -51,23 +50,25 @@ export * from './augments/object/object-entries.js';
 export * from './augments/object/object-filter.js';
 export * from './augments/object/object-keys.js';
 export * from './augments/object/object-values.js';
+export * from './augments/path/esm-path.js';
 export * from './augments/prisma/prisma-models.js';
 export * from './augments/promise/timed-promise.js';
 export * from './augments/random/random-boolean.js';
 export * from './augments/random/random-integer.js';
 export * from './augments/random/random-string.js';
+export * from './augments/regexp/match.js';
 export * from './augments/regexp/regexp-flags.js';
 export * from './augments/regexp/regexp-string.js';
-export * from './augments/regexp/safe-match.js';
 export * from './augments/selection-set/select-collapsed.js';
 export * from './augments/selection-set/select-from.js';
 export * from './augments/selection-set/selection-set.js';
 export * from './augments/string/casing/capitalization.js';
 export * from './augments/string/casing/casing.js';
 export * from './augments/string/casing/kebab-and-camel.js';
-export * from './augments/string/commas.js';
+export * from './augments/string/comma.js';
 export * from './augments/string/join.js';
 export * from './augments/string/prefix.js';
+export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/replace.js';
 export * from './augments/string/split.js';
 export * from './augments/string/substring-index.js';
@@ -77,5 +78,6 @@ export * from './augments/string/wrap-string.js';
 export * from './augments/type/ensure-type.js';
 export * from './augments/type/readonly.js';
 export * from './augments/type/type-recursion.js';
+export * from './augments/type/union.js';
 export * from './augments/type/void-type.js';
 export * from './augments/type/writable.js';

package/dist/index.js

@@ -8,15 +8,14 @@ export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/repeat-array.js';
 export * from './augments/array/shuffle-array.js';
 export * from './augments/array/string-array.js';
-export * from './augments/boolean/if-truthy.js';
 export * from './augments/core-exports.js';
 export * from './augments/enum/enum-value-check.js';
 export * from './augments/error/combine-errors.js';
-export * from './augments/file/esm-path.js';
 export * from './augments/function/call-asynchronously.js';
 export * from './augments/function/call-with-retries.js';
 export * from './augments/function/debounce.js';
 export * from './augments/function/execution-duration.js';
+export * from './augments/function/if-truthy.js';
 export * from './augments/function/wrap-in-try.js';
 export * from './augments/json/append-json.js';
 export * from './augments/json/copy-through-json.js';
@@ -51,23 +50,25 @@ export * from './augments/object/object-entries.js';
 export * from './augments/object/object-filter.js';
 export * from './augments/object/object-keys.js';
 export * from './augments/object/object-values.js';
+export * from './augments/path/esm-path.js';
 export * from './augments/prisma/prisma-models.js';
 export * from './augments/promise/timed-promise.js';
 export * from './augments/random/random-boolean.js';
 export * from './augments/random/random-integer.js';
 export * from './augments/random/random-string.js';
+export * from './augments/regexp/match.js';
 export * from './augments/regexp/regexp-flags.js';
 export * from './augments/regexp/regexp-string.js';
-export * from './augments/regexp/safe-match.js';
 export * from './augments/selection-set/select-collapsed.js';
 export * from './augments/selection-set/select-from.js';
 export * from './augments/selection-set/selection-set.js';
 export * from './augments/string/casing/capitalization.js';
 export * from './augments/string/casing/casing.js';
 export * from './augments/string/casing/kebab-and-camel.js';
-export * from './augments/string/commas.js';
+export * from './augments/string/comma.js';
 export * from './augments/string/join.js';
 export * from './augments/string/prefix.js';
+export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/replace.js';
 export * from './augments/string/split.js';
 export * from './augments/string/substring-index.js';
@@ -77,5 +78,6 @@ export * from './augments/string/wrap-string.js';
 export * from './augments/type/ensure-type.js';
 export * from './augments/type/readonly.js';
 export * from './augments/type/type-recursion.js';
+export * from './augments/type/union.js';
 export * from './augments/type/void-type.js';
 export * from './augments/type/writable.js';

package/package.json

@@ -1,6 +1,18 @@
 {
     "name": "@augment-vir/common",
-    "version": "30.0.0",
+    "version": "30.0.1",
+    "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
+    "keywords": [
+        "augment",
+        "helper",
+        "util",
+        "node",
+        "browser",
+        "backend",
+        "frontend",
+        "vir",
+        "augment-vir"
+    ],
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -20,17 +32,15 @@
     "types": "dist/index.d.ts",
     "scripts": {
         "compile": "virmator compile",
-        "docs": "virmator docs",
         "test": "concurrently --colors --kill-others-on-fail -c red,blue --names node,web \"npm run test:node\" \"npm run test:web\"",
         "test:coverage": "virmator --no-deps test web coverage",
-        "test:docs": "virmator docs check",
         "test:node": "virmator --no-deps test node",
         "test:update": "npm test",
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.0.0",
-        "@augment-vir/core": "^30.0.0",
+        "@augment-vir/assert": "^30.0.1",
+        "@augment-vir/core": "^30.0.1",
         "@date-vir/duration": "^6.0.0",
         "ansi-styles": "^6.2.1",
         "json5": "^2.2.3",

package/dist/augments/boolean/if-truthy.d.ts

@@ -1,2 +0,0 @@
-import { type Falsy, type Truthy } from '@augment-vir/assert';
-export declare function ifTruthy<const InputType, IfTruthyType, IfFalsyType>(checkThis: InputType, ifTruthyCallback: (truthyInput: Truthy<InputType>) => IfTruthyType, ifFalsyCallback: (truthyInput: Falsy<InputType>) => IfFalsyType): IfTruthyType | IfFalsyType;

package/dist/augments/boolean/if-truthy.js

@@ -1,9 +0,0 @@
-import { check } from '@augment-vir/assert';
-export function ifTruthy(checkThis, ifTruthyCallback, ifFalsyCallback) {
-    if (check.isTruthy(checkThis)) {
-        return ifTruthyCallback(checkThis);
-    }
-    else {
-        return ifFalsyCallback(checkThis);
-    }
-}

package/dist/augments/file/esm-path.d.ts

@@ -1,4 +0,0 @@
-export declare function getEsmPath(importMeta: ImportMeta): {
-    filePath: string;
-    dirPath: string;
-};

package/dist/augments/file/esm-path.js

@@ -1,8 +0,0 @@
-export function getEsmPath(importMeta) {
-    const filePath = new URL('', importMeta.url).pathname;
-    const dirPath = new URL('.', importMeta.url).pathname;
-    return {
-        filePath,
-        dirPath,
-    };
-}

package/dist/augments/regexp/safe-match.d.ts

@@ -1 +0,0 @@
-export declare function safeMatch(input: string, regExp: RegExp): string[];

package/dist/augments/regexp/safe-match.js

@@ -1,4 +0,0 @@
-export function safeMatch(input, regExp) {
-    const match = input.match(regExp);
-    return match ?? [];
-}

package/dist/augments/string/commas.d.ts

@@ -1,7 +0,0 @@
-/**
- * Removes all commas from the given string.
- *
- * @category String:Common
- */
-export declare function removeCommas(input: string): string;
-export declare function addCommasToNumber(input: number | string): string;