Function assertFunction

Asserts a function.

Asserts a function, by wrapping the function and checking its parameters and return value through assert function. If some parameter or return value 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 assert function. If the TypeGuardError 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 just finding the 1st type error through assertion, but also finding every type errors, then use validateFunction instead. Otherwise, what you want is just asserting parameters or return value only, you can use assertParameters or assertReturn instead.

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