Function validateFunction

  • Validates a function.

    Validates a function, by wrapping the function and checking its parameters and return value through validate function. If some parameter or return value does not match the expected type, it returns IValidation.IError typed object. Otherwise there's no type error, it returns IValidation.ISuccess typed object instead.

    For reference, IValidation.IError.path would be a little bit different with individual validate function. If the IValidation.IError occurs from some parameter, the path would start from $input.parameters[number]. Otherwise the path would start from $input.return.

    • $input.parameters[0].~
    • $input.return.~

    By the way, if what you want is not finding every type errors, but just finding the 1st type error, then use assertFunction instead. Otherwise, what you want is just validating parameters or return value only, you can use validateParameters or validateReturn instead.

    On the other hand, if you don't want to allow any superfluous properties, utilize validateEqualsFunction or assertEqualsFunction instead.

    Type Parameters

    • T extends ((...args: any[]) => any)

      Target function type

    Parameters

    • func: T

      Target function to validate

    Returns T extends ((...args: infer Arguments) => infer Output)
        ? Output extends Promise<infer R>
            ? ((...args: Arguments) => Promise<IValidation<R>>)
            : ((...args: Arguments) => IValidation<Output>)
        : never

    The wrapper function with type validations

    Jeongho Nam - https://github.com/samchon