@augment-vir/common 11.3.0 → 12.0.0

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

@@ -3,18 +3,18 @@ declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean
 type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
 export type RuntimeTypeOf = RawTypeOf | 'array';
 export type RuntimeTypeOfMapping = {
-    array: any[];
+    array: any[] | ReadonlyArray<any>;
     bigint: bigint;
     boolean: boolean;
-    function: AnyFunction;
+    function: AnyFunction | Readonly<AnyFunction>;
     number: number;
-    object: Record<PropertyKey, unknown>;
+    object: Record<PropertyKey, unknown> | Readonly<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 declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T, inputName: string): asserts input is RuntimeTypeOfMapping[T];
 export {};
 //# sourceMappingURL=runtime-type-of.d.ts.map

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

@@ -15,9 +15,9 @@ function isRuntimeTypeOf(input, testType) {
     return inputType === testType;
 }
 exports.isRuntimeTypeOf = isRuntimeTypeOf;
-function assertRuntimeTypeOf(input, testType) {
+function assertRuntimeTypeOf(input, testType, inputName) {
     if (!isRuntimeTypeOf(input, testType)) {
-        throw new TypeError(`'${input}' is not of type '${testType}'`);
+        throw new TypeError(`'${inputName}' is of type '${getRuntimeTypeOf(input)}' but type '${testType}' was expected.`);
     }
 }
 exports.assertRuntimeTypeOf = assertRuntimeTypeOf;

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

@@ -58,4 +58,5 @@ export type NoInfer<T> = [T][T extends any ? 0 : never];
  * input.
  */
 export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;
+export type TypedFunction<ParametersGeneric extends any[], ReturnTypeGeneric> = (...args: ParametersGeneric) => ReturnTypeGeneric;
 //# sourceMappingURL=type.d.ts.map

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

@@ -3,18 +3,18 @@ declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean
 type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
 export type RuntimeTypeOf = RawTypeOf | 'array';
 export type RuntimeTypeOfMapping = {
-    array: any[];
+    array: any[] | ReadonlyArray<any>;
     bigint: bigint;
     boolean: boolean;
-    function: AnyFunction;
+    function: AnyFunction | Readonly<AnyFunction>;
     number: number;
-    object: Record<PropertyKey, unknown>;
+    object: Record<PropertyKey, unknown> | Readonly<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 declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T, inputName: string): asserts input is RuntimeTypeOfMapping[T];
 export {};
 //# sourceMappingURL=runtime-type-of.d.ts.map

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

@@ -10,8 +10,8 @@ export function isRuntimeTypeOf(input, testType) {
     const inputType = getRuntimeTypeOf(input);
     return inputType === testType;
 }
-export function assertRuntimeTypeOf(input, testType) {
+export function assertRuntimeTypeOf(input, testType, inputName) {
     if (!isRuntimeTypeOf(input, testType)) {
-        throw new TypeError(`'${input}' is not of type '${testType}'`);
+        throw new TypeError(`'${inputName}' is of type '${getRuntimeTypeOf(input)}' but type '${testType}' was expected.`);
     }
 }

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

@@ -58,4 +58,5 @@ export type NoInfer<T> = [T][T extends any ? 0 : never];
  * input.
  */
 export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;
+export type TypedFunction<ParametersGeneric extends any[], ReturnTypeGeneric> = (...args: ParametersGeneric) => ReturnTypeGeneric;
 //# sourceMappingURL=type.d.ts.map

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

@@ -3,18 +3,18 @@ declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean
 type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
 export type RuntimeTypeOf = RawTypeOf | 'array';
 export type RuntimeTypeOfMapping = {
-    array: any[];
+    array: any[] | ReadonlyArray<any>;
     bigint: bigint;
     boolean: boolean;
-    function: AnyFunction;
+    function: AnyFunction | Readonly<AnyFunction>;
     number: number;
-    object: Record<PropertyKey, unknown>;
+    object: Record<PropertyKey, unknown> | Readonly<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 declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T, inputName: string): asserts input is RuntimeTypeOfMapping[T];
 export {};
 //# sourceMappingURL=runtime-type-of.d.ts.map

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

@@ -58,4 +58,5 @@ export type NoInfer<T> = [T][T extends any ? 0 : never];
  * input.
  */
 export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;
+export type TypedFunction<ParametersGeneric extends any[], ReturnTypeGeneric> = (...args: ParametersGeneric) => ReturnTypeGeneric;
 //# sourceMappingURL=type.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "11.3.0",
+    "version": "12.0.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,7 +24,7 @@
         "test:types": "tsc --noEmit"
     },
     "dependencies": {
-        "type-fest": "^3.5.1"
+        "type-fest": "^3.5.3"
     },
     "devDependencies": {
         "typescript": "^4.9.4"