Function assertReturn

Asserts return value.

Asserts a function, by wrapping the function and checking its return value through assert function. If the 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 the return value, the path would start from $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 validateReturn instead. Otherwise, what you want is not only asserting return value, but also asserting parameters, you can use assertFunction instead.

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

Throws

A TypeGuardError or a custom error generated by errorFactory

Author

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