kylefang/react-native-firebase
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-firebase.git synced 2026-04-24 04:24:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(storage): add note about errors #3033 (#3034)

Browse Source 
This is a suggested way to improve the error documentation of this package. I've talked more about my feelings about the current state of the error documentation in #3033
This commit is contained in:
Anderson Addo
2019-12-30 05:28:52 -08:00
committed by Mike Diarmid
parent 2e2b24e51d
commit da0408ca4e
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/storage/index.md
View File

@@ -40,6 +40,14 @@ directly from your device and from your Firebase Cloud Storage bucket.
</Block>
</Grid>
## Errors
The functions in this module can throw two different types of errors. If ill-formed urls are passed into them, they will throw
[generic Errors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) with messages
explaining the problem that caused them.
If error was thrown by Firebase itself, then the function will throw a [NativeFirebaseError](https://invertase.io/oss/react-native-firebase/v6/app/reference/nativefirebaseerror). The codes for these errors are the same as the codes for [Firebase Cloud Storage Web errors](https://firebase.google.com/docs/storage/web/handle-errors).
## Learn more
Our documentation is a great place to start, however if you're looking for more help or want to help others,