Doc : Add errors from API handling examples #633
Merged
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.
Fix Issue #582
I found out, by reading the source code, that aws-amplify is using Axios to handle http calls. This choice introduce a particular way of manage errors coming from API comparing to Fetch. (see this issue )
This PR is a proposal for explicitly tell developers that Axios is used.
By doing this, it also makes much clearer the use of an
init
object (calledmyInit
in the examples) as a parameter of theget()
,post()
, etc. methods. This object is indeed, at the end, the documentedparam
parameter in the corresponding methods in Axios.It also warn the developers that status code > 299 are thrown as an exception. Which is not obvious when using Fetch.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.