@xylabs/object - npm Package Compare versions

Comparing version 3.2.0 to 3.3.0

dist/browser/asObject.d.ts

 import { AnyObject } from './AnyObject';
 export declare const asAnyObject: {
-    <TType extends AnyObject>(value: import("@xylabs/promise").AnyNonPromise, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
-    <TType_1 extends AnyObject>(value: import("@xylabs/promise").AnyNonPromise, assert: import("./AsTypeFactory").StringOrAlertFunction<AnyObject>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
+    <TType extends AnyObject>(value: string | number | bigint | boolean | symbol | object | Function | AnyObject | {
+        [key: string]: import("@xylabs/promise").TypedValue;
+        [key: number]: import("@xylabs/promise").TypedValue;
+        [key: symbol]: import("@xylabs/promise").TypedValue;
+    } | import("@xylabs/promise").TypedArray | null, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
+    <TType_1 extends AnyObject>(value: string | number | bigint | boolean | symbol | object | Function | AnyObject | {
+        [key: string]: import("@xylabs/promise").TypedValue;
+        [key: number]: import("@xylabs/promise").TypedValue;
+        [key: symbol]: import("@xylabs/promise").TypedValue;
+    } | import("@xylabs/promise").TypedArray | null, assert: import("./AsTypeFactory").StringOrAlertFunction<AnyObject>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
 };
 //# sourceMappingURL=asObject.d.ts.map

dist/browser/AsObjectFactory.d.ts

 import { TypedObject } from '@xylabs/promise';
 import { TypeCheck } from './AsTypeFactory';
 export declare const AsObjectFactory: {
-    create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => {
-        <TType extends T>(value: import("@xylabs/promise").AnyNonPromise, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
-        <TType_1 extends T>(value: import("@xylabs/promise").AnyNonPromise, assert: import("./AsTypeFactory").StringOrAlertFunction<T>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
+    create: <T extends TypedObject, E = void>(typeCheck: TypeCheck<T, E>) => {
+        <TType extends T>(value: T | (E extends void ? Exclude<undefined, E> | Exclude<null, E> | Exclude<string, E> | Exclude<number, E> | Exclude<bigint, E> | Exclude<false, E> | Exclude<true, E> | Exclude<symbol, E> | Exclude<object, E> | Exclude<Function, E> | Exclude<{
+            [key: string]: import("@xylabs/promise").TypedValue;
+            [key: number]: import("@xylabs/promise").TypedValue;
+            [key: symbol]: import("@xylabs/promise").TypedValue;
+        }, E> | Exclude<import("@xylabs/promise").TypedArray, E> : import("@xylabs/promise").AnyNonPromise), config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
+        <TType_1 extends T>(value: T | (E extends void ? Exclude<undefined, E> | Exclude<null, E> | Exclude<string, E> | Exclude<number, E> | Exclude<bigint, E> | Exclude<false, E> | Exclude<true, E> | Exclude<symbol, E> | Exclude<object, E> | Exclude<Function, E> | Exclude<{
+            [key: string]: import("@xylabs/promise").TypedValue;
+            [key: number]: import("@xylabs/promise").TypedValue;
+            [key: symbol]: import("@xylabs/promise").TypedValue;
+        }, E> | Exclude<import("@xylabs/promise").TypedArray, E> : import("@xylabs/promise").AnyNonPromise), assert: import("./AsTypeFactory").StringOrAlertFunction<T>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
     };
 };
 //# sourceMappingURL=AsObjectFactory.d.ts.map

dist/browser/AsTypeFactory.d.ts

@@ -5,12 +5,13 @@ import { AssertExMessageFunc } from '@xylabs/assert';
 export interface TypeCheckConfig {
+    disallowChecks?: ((value: unknown) => unknown)[];
     log?: boolean | Logger;
 }
 export type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>;
-export type TypeCheck<T extends TypedValue> = (obj: AnyNonPromise, config?: TypeCheckConfig) => obj is T;
+export type TypeCheck<T extends TypedValue, E = void> = (obj: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, config?: TypeCheckConfig) => obj is T;
 export declare const AsTypeFactory: {
-    create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => {
-        <TType extends T>(value: AnyNonPromise, config?: TypeCheckConfig): TType | undefined;
-        <TType_1 extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<T>, config?: TypeCheckConfig): TType_1;
+    create: <T extends AnyNonPromise, E = void>(typeCheck: TypeCheck<T, E>) => {
+        <TType extends T>(value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, config?: TypeCheckConfig): TType | undefined;
+        <TType_1 extends T>(value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, assert: StringOrAlertFunction<T>, config?: TypeCheckConfig): TType_1;
     };
 };
 //# sourceMappingURL=AsTypeFactory.d.ts.map

dist/browser/index.js

@@ -17,2 +17,7 @@ // src/AsTypeFactory.ts
       }
+      for (const disallowCheck of config?.disallowChecks ?? []) {
+        if (disallowCheck(value)) {
+          throw new TypeError("disallowed type");
+        }
+      }
       const resolvedAssert = typeof assertOrConfig === "object" ? void 0 : assertOrConfig;
@@ -19,0 +24,0 @@ const resolvedConfig = typeof assertOrConfig === "object" ? assertOrConfig : config;

dist/neutral/asObject.d.ts

 import { AnyObject } from './AnyObject';
 export declare const asAnyObject: {
-    <TType extends AnyObject>(value: import("@xylabs/promise").AnyNonPromise, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
-    <TType_1 extends AnyObject>(value: import("@xylabs/promise").AnyNonPromise, assert: import("./AsTypeFactory").StringOrAlertFunction<AnyObject>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
+    <TType extends AnyObject>(value: string | number | bigint | boolean | symbol | object | Function | AnyObject | {
+        [key: string]: import("@xylabs/promise").TypedValue;
+        [key: number]: import("@xylabs/promise").TypedValue;
+        [key: symbol]: import("@xylabs/promise").TypedValue;
+    } | import("@xylabs/promise").TypedArray | null, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
+    <TType_1 extends AnyObject>(value: string | number | bigint | boolean | symbol | object | Function | AnyObject | {
+        [key: string]: import("@xylabs/promise").TypedValue;
+        [key: number]: import("@xylabs/promise").TypedValue;
+        [key: symbol]: import("@xylabs/promise").TypedValue;
+    } | import("@xylabs/promise").TypedArray | null, assert: import("./AsTypeFactory").StringOrAlertFunction<AnyObject>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
 };
 //# sourceMappingURL=asObject.d.ts.map

dist/neutral/AsObjectFactory.d.ts

 import { TypedObject } from '@xylabs/promise';
 import { TypeCheck } from './AsTypeFactory';
 export declare const AsObjectFactory: {
-    create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => {
-        <TType extends T>(value: import("@xylabs/promise").AnyNonPromise, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
-        <TType_1 extends T>(value: import("@xylabs/promise").AnyNonPromise, assert: import("./AsTypeFactory").StringOrAlertFunction<T>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
+    create: <T extends TypedObject, E = void>(typeCheck: TypeCheck<T, E>) => {
+        <TType extends T>(value: T | (E extends void ? Exclude<undefined, E> | Exclude<null, E> | Exclude<string, E> | Exclude<number, E> | Exclude<bigint, E> | Exclude<false, E> | Exclude<true, E> | Exclude<symbol, E> | Exclude<object, E> | Exclude<Function, E> | Exclude<{
+            [key: string]: import("@xylabs/promise").TypedValue;
+            [key: number]: import("@xylabs/promise").TypedValue;
+            [key: symbol]: import("@xylabs/promise").TypedValue;
+        }, E> | Exclude<import("@xylabs/promise").TypedArray, E> : import("@xylabs/promise").AnyNonPromise), config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
+        <TType_1 extends T>(value: T | (E extends void ? Exclude<undefined, E> | Exclude<null, E> | Exclude<string, E> | Exclude<number, E> | Exclude<bigint, E> | Exclude<false, E> | Exclude<true, E> | Exclude<symbol, E> | Exclude<object, E> | Exclude<Function, E> | Exclude<{
+            [key: string]: import("@xylabs/promise").TypedValue;
+            [key: number]: import("@xylabs/promise").TypedValue;
+            [key: symbol]: import("@xylabs/promise").TypedValue;
+        }, E> | Exclude<import("@xylabs/promise").TypedArray, E> : import("@xylabs/promise").AnyNonPromise), assert: import("./AsTypeFactory").StringOrAlertFunction<T>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
     };
 };
 //# sourceMappingURL=AsObjectFactory.d.ts.map

dist/neutral/AsTypeFactory.d.ts

@@ -5,12 +5,13 @@ import { AssertExMessageFunc } from '@xylabs/assert';
 export interface TypeCheckConfig {
+    disallowChecks?: ((value: unknown) => unknown)[];
     log?: boolean | Logger;
 }
 export type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>;
-export type TypeCheck<T extends TypedValue> = (obj: AnyNonPromise, config?: TypeCheckConfig) => obj is T;
+export type TypeCheck<T extends TypedValue, E = void> = (obj: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, config?: TypeCheckConfig) => obj is T;
 export declare const AsTypeFactory: {
-    create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => {
-        <TType extends T>(value: AnyNonPromise, config?: TypeCheckConfig): TType | undefined;
-        <TType_1 extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<T>, config?: TypeCheckConfig): TType_1;
+    create: <T extends AnyNonPromise, E = void>(typeCheck: TypeCheck<T, E>) => {
+        <TType extends T>(value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, config?: TypeCheckConfig): TType | undefined;
+        <TType_1 extends T>(value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, assert: StringOrAlertFunction<T>, config?: TypeCheckConfig): TType_1;
     };
 };
 //# sourceMappingURL=AsTypeFactory.d.ts.map

dist/neutral/index.js

@@ -17,2 +17,7 @@ // src/AsTypeFactory.ts
       }
+      for (const disallowCheck of config?.disallowChecks ?? []) {
+        if (disallowCheck(value)) {
+          throw new TypeError("disallowed type");
+        }
+      }
       const resolvedAssert = typeof assertOrConfig === "object" ? void 0 : assertOrConfig;
@@ -19,0 +24,0 @@ const resolvedConfig = typeof assertOrConfig === "object" ? assertOrConfig : config;

dist/node/asObject.d.ts

 import { AnyObject } from './AnyObject';
 export declare const asAnyObject: {
-    <TType extends AnyObject>(value: import("@xylabs/promise").AnyNonPromise, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
-    <TType_1 extends AnyObject>(value: import("@xylabs/promise").AnyNonPromise, assert: import("./AsTypeFactory").StringOrAlertFunction<AnyObject>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
+    <TType extends AnyObject>(value: string | number | bigint | boolean | symbol | object | Function | AnyObject | {
+        [key: string]: import("@xylabs/promise").TypedValue;
+        [key: number]: import("@xylabs/promise").TypedValue;
+        [key: symbol]: import("@xylabs/promise").TypedValue;
+    } | import("@xylabs/promise").TypedArray | null, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
+    <TType_1 extends AnyObject>(value: string | number | bigint | boolean | symbol | object | Function | AnyObject | {
+        [key: string]: import("@xylabs/promise").TypedValue;
+        [key: number]: import("@xylabs/promise").TypedValue;
+        [key: symbol]: import("@xylabs/promise").TypedValue;
+    } | import("@xylabs/promise").TypedArray | null, assert: import("./AsTypeFactory").StringOrAlertFunction<AnyObject>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
 };
 //# sourceMappingURL=asObject.d.ts.map

dist/node/AsObjectFactory.d.ts

 import { TypedObject } from '@xylabs/promise';
 import { TypeCheck } from './AsTypeFactory';
 export declare const AsObjectFactory: {
-    create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => {
-        <TType extends T>(value: import("@xylabs/promise").AnyNonPromise, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
-        <TType_1 extends T>(value: import("@xylabs/promise").AnyNonPromise, assert: import("./AsTypeFactory").StringOrAlertFunction<T>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
+    create: <T extends TypedObject, E = void>(typeCheck: TypeCheck<T, E>) => {
+        <TType extends T>(value: T | (E extends void ? Exclude<undefined, E> | Exclude<null, E> | Exclude<string, E> | Exclude<number, E> | Exclude<bigint, E> | Exclude<false, E> | Exclude<true, E> | Exclude<symbol, E> | Exclude<object, E> | Exclude<Function, E> | Exclude<{
+            [key: string]: import("@xylabs/promise").TypedValue;
+            [key: number]: import("@xylabs/promise").TypedValue;
+            [key: symbol]: import("@xylabs/promise").TypedValue;
+        }, E> | Exclude<import("@xylabs/promise").TypedArray, E> : import("@xylabs/promise").AnyNonPromise), config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType | undefined;
+        <TType_1 extends T>(value: T | (E extends void ? Exclude<undefined, E> | Exclude<null, E> | Exclude<string, E> | Exclude<number, E> | Exclude<bigint, E> | Exclude<false, E> | Exclude<true, E> | Exclude<symbol, E> | Exclude<object, E> | Exclude<Function, E> | Exclude<{
+            [key: string]: import("@xylabs/promise").TypedValue;
+            [key: number]: import("@xylabs/promise").TypedValue;
+            [key: symbol]: import("@xylabs/promise").TypedValue;
+        }, E> | Exclude<import("@xylabs/promise").TypedArray, E> : import("@xylabs/promise").AnyNonPromise), assert: import("./AsTypeFactory").StringOrAlertFunction<T>, config?: import("./AsTypeFactory").TypeCheckConfig | undefined): TType_1;
     };
 };
 //# sourceMappingURL=AsObjectFactory.d.ts.map

dist/node/AsTypeFactory.d.ts

@@ -5,12 +5,13 @@ import { AssertExMessageFunc } from '@xylabs/assert';
 export interface TypeCheckConfig {
+    disallowChecks?: ((value: unknown) => unknown)[];
     log?: boolean | Logger;
 }
 export type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>;
-export type TypeCheck<T extends TypedValue> = (obj: AnyNonPromise, config?: TypeCheckConfig) => obj is T;
+export type TypeCheck<T extends TypedValue, E = void> = (obj: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, config?: TypeCheckConfig) => obj is T;
 export declare const AsTypeFactory: {
-    create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => {
-        <TType extends T>(value: AnyNonPromise, config?: TypeCheckConfig): TType | undefined;
-        <TType_1 extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<T>, config?: TypeCheckConfig): TType_1;
+    create: <T extends AnyNonPromise, E = void>(typeCheck: TypeCheck<T, E>) => {
+        <TType extends T>(value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, config?: TypeCheckConfig): TType | undefined;
+        <TType_1 extends T>(value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T, assert: StringOrAlertFunction<T>, config?: TypeCheckConfig): TType_1;
     };
 };
 //# sourceMappingURL=AsTypeFactory.d.ts.map

dist/node/index.js

@@ -17,2 +17,7 @@ // src/AsTypeFactory.ts
       }
+      for (const disallowCheck of (config == null ? void 0 : config.disallowChecks) ?? []) {
+        if (disallowCheck(value)) {
+          throw new TypeError("disallowed type");
+        }
+      }
       const resolvedAssert = typeof assertOrConfig === "object" ? void 0 : assertOrConfig;
@@ -19,0 +24,0 @@ const resolvedConfig = typeof assertOrConfig === "object" ? assertOrConfig : config;

package.json

@@ -14,5 +14,5 @@ {
   "dependencies": {
-    "@xylabs/assert": "^3.2.0",
-    "@xylabs/logger": "^3.2.0",
-    "@xylabs/promise": "^3.2.0"
+    "@xylabs/assert": "^3.3.0",
+    "@xylabs/logger": "^3.3.0",
+    "@xylabs/promise": "^3.3.0"
   },
@@ -62,4 +62,4 @@ "devDependencies": {
   "sideEffects": false,
-  "version": "3.2.0",
+  "version": "3.3.0",
   "type": "module"
 }

src/AsObjectFactory.ts

@@ -6,5 +6,5 @@ import { TypedObject } from '@xylabs/promise'
 export const AsObjectFactory = {
-  create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => {
-    return AsTypeFactory.create<T>(typeCheck)
+  create: <T extends TypedObject, E = void>(typeCheck: TypeCheck<T, E>) => {
+    return AsTypeFactory.create<T, E>(typeCheck)
   },
 }

src/AsTypeFactory.ts

@@ -6,2 +6,3 @@ import { assertEx, AssertExMessageFunc } from '@xylabs/assert'
 export interface TypeCheckConfig {
+  disallowChecks?: ((value: unknown) => unknown)[]
   log?: boolean | Logger
@@ -12,10 +13,13 @@ }
 
-export type TypeCheck<T extends TypedValue> = (obj: AnyNonPromise, config?: TypeCheckConfig) => obj is T
+export type TypeCheck<T extends TypedValue, E = void> = (
+  obj: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T,
+  config?: TypeCheckConfig,
+) => obj is T
 
 export const AsTypeFactory = {
   // eslint-disable-next-line @typescript-eslint/ban-types
-  create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => {
+  create: <T extends AnyNonPromise, E = void>(typeCheck: TypeCheck<T, E>) => {
     function func<TType extends T>(
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      value: AnyNonPromise,
+      value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T,
       config?: TypeCheckConfig,
@@ -25,3 +29,3 @@ ): TType | undefined
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      value: AnyNonPromise,
+      value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T,
       assert: StringOrAlertFunction<T>,
@@ -32,3 +36,3 @@ config?: TypeCheckConfig,
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      value: AnyNonPromise,
+      value: (E extends void ? Exclude<AnyNonPromise, E> : AnyNonPromise) | T,
       assertOrConfig?: StringOrAlertFunction<T> | TypeCheckConfig,
@@ -49,2 +53,8 @@ config?: TypeCheckConfig,
 
+      for (const disallowCheck of config?.disallowChecks ?? []) {
+        if (disallowCheck(value)) {
+          throw new TypeError('disallowed type')
+        }
+      }
+
       const resolvedAssert = (typeof assertOrConfig === 'object' ? undefined : assertOrConfig) as StringOrAlertFunction<T> | undefined
@@ -51,0 +61,0 @@ const resolvedConfig = typeof assertOrConfig === 'object' ? assertOrConfig : config

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

431307

increased by6.01%

Lines of code

3048

increased by3.04%

Dependency changes

• Updated@xylabs/assert@^3.3.0

• Updated@xylabs/logger@^3.3.0

• Updated@xylabs/promise@^3.3.0