docs(error-handling): add string vs object errors and update createError jsdoc
#762
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… client-server context
…ation to client side
pi0
reviewed
May 27, 2024
src/error.ts
Outdated
| @@ -62,6 +62,7 @@ export class H3Error<DataT = unknown> extends Error { | |||
| * Creates a new `Error` that can be used to handle both internal and runtime errors. | |||
| * | |||
| * @param input {string | (Partial<H3Error> & { status?: number; statusText?: string })} - The error message or an object containing error properties. | |||
| * If a string is provided, it will be used as the error `message`. Remember to use either `statusMessage` or `data` to pass error information to the client. | |||
There was a problem hiding this comment.
This is nice. We might also add markdown docs and examples (similar, maybe smaller version of docs) here as well so when people hover their mouse on utility in their IDE, they see nice inline docs and tip.
There was a problem hiding this comment.
Thanks Pooya! I've made some revisions in that direction, what do you think about it now?
pi0
reviewed
May 27, 2024
Co-authored-by: Pooya Parsa <pyapar@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🔗 Linked issue
#761
❓ Type of change
📚 Description
I have always been somewhat confused on how to initialize
createError, either with a string or an object. Similarly, it was unclear at first which one to use to pass data to the client in an error thrown from the server.📝 Checklist
🗒️ Note
This is my first-ever open source contribution so I may not have configured the issue/pr or the contribution itself as needed. I'd love to hear if that is the case and I'll fix whatever is missing.
And just for context: @pi0 this is the pr I am opening per your suggestion over Twitter. Thanks for the nudge!