@augment-vir/common 7.1.0 → 8.0.0

package/dist/cjs/augments/runtime-type-of.d.ts

@@ -0,0 +1,20 @@
+import { AnyFunction } from './function';
+declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
+export type RuntimeTypeOf = RawTypeOf | 'array';
+export type RuntimeTypeOfMapping = {
+    array: any[];
+    bigint: bigint;
+    boolean: boolean;
+    function: AnyFunction;
+    number: number;
+    object: Record<PropertyKey, unknown>;
+    string: string;
+    symbol: symbol;
+    undefined: undefined;
+};
+export declare function getRuntimeTypeOf(input: unknown): RuntimeTypeOf;
+export declare function isRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): input is RuntimeTypeOfMapping[T];
+export declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): asserts input is RuntimeTypeOfMapping[T];
+export {};
+//# sourceMappingURL=runtime-type-of.d.ts.map

package/dist/cjs/augments/runtime-type-of.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertRuntimeTypeOf = exports.isRuntimeTypeOf = exports.getRuntimeTypeOf = void 0;
+// this function is not used at run time, it's only here for types
+// istanbul ignore next
+function rawGetTypeOf(x) {
+    return typeof x;
+}
+function getRuntimeTypeOf(input) {
+    return Array.isArray(input) ? 'array' : typeof input;
+}
+exports.getRuntimeTypeOf = getRuntimeTypeOf;
+function isRuntimeTypeOf(input, testType) {
+    const inputType = getRuntimeTypeOf(input);
+    return inputType === testType;
+}
+exports.isRuntimeTypeOf = isRuntimeTypeOf;
+function assertRuntimeTypeOf(input, testType) {
+    if (!isRuntimeTypeOf(input, testType)) {
+        throw new TypeError(`'${input}' is not of type '${testType}'`);
+    }
+}
+exports.assertRuntimeTypeOf = assertRuntimeTypeOf;

package/dist/cjs/index.d.ts

@@ -12,8 +12,8 @@ export * from './augments/object';
 export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
+export * from './augments/runtime-type-of';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';
-export * from './augments/type-of';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.js

@@ -28,7 +28,7 @@ __exportStar(require("./augments/object"), exports);
 __exportStar(require("./augments/pick-deep"), exports);
 __exportStar(require("./augments/promise"), exports);
 __exportStar(require("./augments/regexp"), exports);
+__exportStar(require("./augments/runtime-type-of"), exports);
 __exportStar(require("./augments/truncate-number"), exports);
 __exportStar(require("./augments/tuple"), exports);
 __exportStar(require("./augments/type"), exports);
-__exportStar(require("./augments/type-of"), exports);

package/dist/esm/augments/runtime-type-of.d.ts

@@ -0,0 +1,20 @@
+import { AnyFunction } from './function';
+declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
+export type RuntimeTypeOf = RawTypeOf | 'array';
+export type RuntimeTypeOfMapping = {
+    array: any[];
+    bigint: bigint;
+    boolean: boolean;
+    function: AnyFunction;
+    number: number;
+    object: Record<PropertyKey, unknown>;
+    string: string;
+    symbol: symbol;
+    undefined: undefined;
+};
+export declare function getRuntimeTypeOf(input: unknown): RuntimeTypeOf;
+export declare function isRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): input is RuntimeTypeOfMapping[T];
+export declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): asserts input is RuntimeTypeOfMapping[T];
+export {};
+//# sourceMappingURL=runtime-type-of.d.ts.map

package/dist/esm/augments/runtime-type-of.js

@@ -0,0 +1,17 @@
+// this function is not used at run time, it's only here for types
+// istanbul ignore next
+function rawGetTypeOf(x) {
+    return typeof x;
+}
+export function getRuntimeTypeOf(input) {
+    return Array.isArray(input) ? 'array' : typeof input;
+}
+export function isRuntimeTypeOf(input, testType) {
+    const inputType = getRuntimeTypeOf(input);
+    return inputType === testType;
+}
+export function assertRuntimeTypeOf(input, testType) {
+    if (!isRuntimeTypeOf(input, testType)) {
+        throw new TypeError(`'${input}' is not of type '${testType}'`);
+    }
+}

package/dist/esm/index.d.ts

@@ -12,8 +12,8 @@ export * from './augments/object';
 export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
+export * from './augments/runtime-type-of';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';
-export * from './augments/type-of';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.js

@@ -12,7 +12,7 @@ export * from './augments/object';
 export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
+export * from './augments/runtime-type-of';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';
-export * from './augments/type-of';

package/dist/types/augments/runtime-type-of.d.ts

@@ -0,0 +1,20 @@
+import { AnyFunction } from './function';
+declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
+export type RuntimeTypeOf = RawTypeOf | 'array';
+export type RuntimeTypeOfMapping = {
+    array: any[];
+    bigint: bigint;
+    boolean: boolean;
+    function: AnyFunction;
+    number: number;
+    object: Record<PropertyKey, unknown>;
+    string: string;
+    symbol: symbol;
+    undefined: undefined;
+};
+export declare function getRuntimeTypeOf(input: unknown): RuntimeTypeOf;
+export declare function isRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): input is RuntimeTypeOfMapping[T];
+export declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): asserts input is RuntimeTypeOfMapping[T];
+export {};
+//# sourceMappingURL=runtime-type-of.d.ts.map

package/dist/types/index.d.ts

@@ -12,8 +12,8 @@ export * from './augments/object';
 export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
+export * from './augments/runtime-type-of';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';
-export * from './augments/type-of';
 //# sourceMappingURL=index.d.ts.map

package/package.json

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