docs(core): update examples to demonstrate z.errors.Error #198
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
FokkeZB
added
documentation
FokkeZB
commented
Apr 10, 2020
| throw new Error('The username and/or password you supplied is incorrect'); | ||
| throw new z.errors.Error( | ||
| 'The username and/or password you supplied is incorrect', | ||
| 'AuthenticationError', |
There was a problem hiding this comment.
The second argument can be any code and as long as we're the only ones able to create troubleshooting docs, this isn't of much direct use to the developer.
However, the idea is/was that we'll grow a set of standard codes that we have generic troubleshooting docs on and ultimately, we'd to list the most common error codes we see for an app in its dashboard and maybe even allow partners to write their own troubleshooting docs for them.
| @@ -8,7 +8,7 @@ const contentDisposition = require('content-disposition') | |||
| // on the OneDrive API. We intentionally don't set it up as an `afterResposne` | |||
| // handler because not *all* calls need it (i.e. the auth test and file create), | |||
| // so we break it out and share the code this way instead. | |||
| const parseResponse = (type, response) => { | |||
| const parseResponse = (z, type, response) => { | |||
There was a problem hiding this comment.
Notice that the signature of this function has changed. All usage has been updated.
eliangcs
approved these changes
Apr 13, 2020
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.
Updates example apps and snippets to demonstrate (and with that encourage) the use of
z.errors.ErroroverError.JIRA:
SXP-1624Replace use of Error by z.errors.Error in examples and docs