Target function to assert
OptionalerrorFactory: ((props: TypeGuardError.IProps) => Error)Custom error factory. Default is TypeGuardError
The wrapper function with type assertions
A TypeGuardError or a custom error generated by errorFactory
Jeongho Nam - https://github.com/samchon
Asserts parameters with strict equality.
Asserts a function, by wrapping the function and checking its parameters through assertEquals function. If some parameter does not match the expected type, it throws an TypeGuardError or a custom error generated by the errorFactory parameter.
For reference, TypeGuardError.path would be a little bit different with individual assertEquals function. If the TypeGuardError occurs from some parameter, the path would start from
$input.parameters[number].By the way, if what you want is not just finding the 1st type error through assertion, but also finding every type errors, then use validateEqualsParameters instead. Otherwise, what you want is not only asserting parameters, but also asserting return value, you can use assertEqualsFunction instead.
On the other hand, if you want to allow any superfluous properties, utilize assertParameters or validateParameters instead.