@xylabs/object 3.2.0 → 3.3.1

package/src/AsTypeFactory.ts

@@ -3,30 +3,34 @@ import { Logger } from '@xylabs/logger'
 import { AnyNonPromise, isPromise, TypedValue } from '@xylabs/promise'
 
 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 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,
     ): TType | undefined
     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,
       assert: StringOrAlertFunction<T>,
       config?: TypeCheckConfig,
     ): TType
     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,
       assertOrConfig?: StringOrAlertFunction<T> | TypeCheckConfig,
       config?: TypeCheckConfig,
     ): TType | undefined {
@@ -42,6 +46,12 @@ export const AsTypeFactory = {
         throw new TypeError('un-awaited promises may not be sent to "as" functions')
       }
 
+      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
       const resolvedConfig = typeof assertOrConfig === 'object' ? assertOrConfig : config
       const result = typeCheck(value, resolvedConfig) ? (value as TType) : undefined

package/src/IsObjectFactory.ts

@@ -5,8 +5,8 @@ import { isType, ObjectTypeShape } from './isType'
 
 export interface ObjectTypeConfig extends TypeCheckConfig {}
 
-export class IsObjectFactory<T extends TypedObject> {
-  create(shape?: ObjectTypeShape, additionalChecks?: TypeCheck<TypedObject>[]): TypeCheck<T> {
+export class IsObjectFactory<T extends TypedObject, E = void> {
+  create(shape?: ObjectTypeShape, additionalChecks?: TypeCheck<TypedObject, E>[]): TypeCheck<T, E> {
     return (obj, { log } = {}): obj is T => {
       if (!obj || typeof obj !== 'object') {
         return false