Better node errors using error messages in output types #2445
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the ability for output types to return error messages. This is useful for complex types where
never_reason
alone isn't enough. Sincenever_reason
is only one message, we previously weren't able to communicate the precise reason for the error, even though the type system knows the reason. I fixed this by allowing output types to return not only their type, but also an optionalError { message: string }
type. This allows us to define relevant error messages, instead of just listing reasons why the node could be invalid.In actual output type code, this looks like this (Alpha Matting node):
Note that this PR doesn't remove
never_reason
.never_reason
is just simpler to use in many cases, and it still provides a useful fallback/default for error messages. I think of the newerror("...")
as an addition, not as a replacement.