Add credits

Author: a7ul

README.md

@@ -1,17 +1,17 @@
-
 # react-native-exception-handler ![npm](https://img.shields.io/npm/dm/react-native-exception-handler.svg)
 
 [![https://nodei.co/npm/react-native-exception-handler.png?downloads=true&downloadRank=true&stars=true](https://nodei.co/npm/react-native-exception-handler.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/react-native-exception-handler)
 
-
 A react native module that lets you to register a global error handler that can capture fatal/non fatal uncaught exceptions.
-The module helps prevent abrupt crashing of RN Apps without a graceful message to the user.   
+The module helps prevent abrupt crashing of RN Apps without a graceful message to the user.
 
 In the current scenario:
-  - `In DEV mode , you get a RED Screen error pointing your errors.`
-  - `In Bundled mode , the app just quits without any prompt !` 🙄
+
+- `In DEV mode , you get a RED Screen error pointing your errors.`
+- `In Bundled mode , the app just quits without any prompt !` 🙄
 
 To tackle this we register a global error handler that could be used to for example:
+
 1. Send bug reports to dev team when the app crashes
 2. Show a creative dialog saying the user should restart the application
 
@@ -21,12 +21,13 @@ To tackle this we register a global error handler that could be used to for exam
 There are **NO** breaking changes. So its safe to upgrade from v1 to v2. So there is no reason not to 😉.
 
 **V2.9**
+
 - Adds support for executing previously set error handlers (now this module can work with other analytics modules)
 - Adds an improved approach for overwriting native error handlers.
 - Thanks @ [Damien Solimando](https://github.com/dsolimando)
 
-**Example** repo can be found here: 
-*[https://github.com/master-atul/react-native-exception-handler-example](https://github.com/master-atul/react-native-exception-handler-example) *
+**Example** repo can be found here:
+_[https://github.com/master-atul/react-native-exception-handler-example](https://github.com/master-atul/react-native-exception-handler-example) _
 
 ### Screens
 
@@ -67,14 +68,12 @@ or
 
 `npm i react-native-exception-handler --save`
 
-
 ### Mostly automatic installation
 
 `react-native link react-native-exception-handler`
 
 ### Manual installation
 
-
 #### iOS
 
 1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
@@ -83,30 +82,32 @@ or
 4. Run your project (`Cmd+R`)<
 
 ##### Using Cocoapods
+
 1. add `pod 'ReactNativeExceptionHandler', :podspec => '../node_modules/react-native-exception-handler/ios/ReactNativeExceptionHandler.podspec'` to your Podfile
 2. run `pod install`
 
 #### Android
 
 1. Open up `android/app/src/main/java/[...]/MainApplication.java`
-  - Add `import com.masteratul.exceptionhandler.ReactNativeExceptionHandlerPackage;` to the imports at the top of the file
-  - Add `new ReactNativeExceptionHandlerPackage()` to the list returned by the `getPackages()` method
+
+- Add `import com.masteratul.exceptionhandler.ReactNativeExceptionHandlerPackage;` to the imports at the top of the file
+- Add `new ReactNativeExceptionHandlerPackage()` to the list returned by the `getPackages()` method
+
 2. Append the following lines to `android/settings.gradle`:
-  	```
-  	include ':react-native-exception-handler'
-  	project(':react-native-exception-handler').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-exception-handler/android')
-  	```
+   ```
+   include ':react-native-exception-handler'
+   project(':react-native-exception-handler').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-exception-handler/android')
+   ```
 3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
-  	```
-      compile project(':react-native-exception-handler')
-  	```
-
+   ```
+     compile project(':react-native-exception-handler')
+   ```
 
 ### PLEASE READ BEFORE GOING TO USAGE SECTION
 
 Lets introduce you to the type of errors in a RN app.
 
-- Errors produced by your Javascript code (includes all your react code). We will refer to these errors as  **JS_Exceptions** going forward.
+- Errors produced by your Javascript code (includes all your react code). We will refer to these errors as **JS_Exceptions** going forward.
 
 - Errors produced by Native Modules. We will refer to these as **Native_Exceptions** going forward.
 
@@ -120,6 +121,7 @@ you CANNOT show a JS alert box or do any UI stuff via JS code. This has to be do
 ### Usage
 
 To catch **JS_Exceptions**
+
 ```js
 import {setJSExceptionHandler, getJSExceptionHandler} from 'react-native-exception-handler';
 
@@ -146,15 +148,15 @@ setJSExceptionHandler(exceptionhandler, allowInDevMode);
 
 // getJSExceptionHandler gives the currently set JS exception handler
 const currentHandler = getJSExceptionHandler();
-```                                     
+```
 
 To catch **Native_Exceptions**
 
 ```js
-import {setNativeExceptionHandler} from 'react-native-exception-handler';
+import { setNativeExceptionHandler } from "react-native-exception-handler";
 
-//For most use cases: 
-setNativeExceptionHandler((exceptionString) => {
+//For most use cases:
+setNativeExceptionHandler(exceptionString => {
   // This is your custom global error handler
   // You do stuff likehit google analytics to track crashes.
   // or hit a custom api to inform the dev team.
@@ -163,30 +165,35 @@ setNativeExceptionHandler((exceptionString) => {
 });
 //====================================================
 // ADVANCED use case:
-const exceptionhandler = (exceptionString) => {
+const exceptionhandler = exceptionString => {
   // your exception handler code here
-}
-setNativeExceptionHandler(exceptionhandler,forceAppQuit,executeDefaultHandler);
+};
+setNativeExceptionHandler(
+  exceptionhandler,
+  forceAppQuit,
+  executeDefaultHandler
+);
 // - exceptionhandler is the exception handler function
 // - forceAppQuit is an optional ANDROID specific parameter that defines
-//    if the app should be force quit on error.  default value is true. 
-//    To see usecase check the common issues section. 
+//    if the app should be force quit on error.  default value is true.
+//    To see usecase check the common issues section.
 // - executeDefaultHandler is an optional boolean (both IOS, ANDROID)
 //    It executes previous exception handlers if set by some other module.
 //    It will come handy when you use any other crash analytics module along with this one
 //    Default value is set to false. Set to true if you are using other analytics modules.
- 
 ```
-It is recommended you set both the handlers.
-NOTE: `setNativeExceptionHandler` only works in bundled mode - it will show the red screen when applied to dev mode. 
 
-**See the examples to know more**                   
+It is recommended you set both the handlers.
+NOTE: `setNativeExceptionHandler` only works in bundled mode - it will show the red screen when applied to dev mode.
 
+**See the examples to know more**
 
 ### CUSTOMIZATION
 
 #### Customizing **setJSExceptionHandler**.
+
 In case of `setJSExceptionHandler` you can do everything that is possible. Hence there is not much to customize here.
+
 ```js
 const errorHandler = (error, isFatal) => {
   // This is your custom global error handler
@@ -211,9 +218,9 @@ In Android and iOS you will see something like
   <img src="https://github.com/master-atul/react-native-exception-handler/raw/master/screens/ios_native_exception.png" width="300"/>
 </p>
 
-**Modifying Android Native Exception handler (RECOMMENDED APPROACH)** 
+**Modifying Android Native Exception handler (RECOMMENDED APPROACH)**
 
-(NATIVE CODE HAS TO BE WRITTEN) *recommended that you do this in android studio*
+(NATIVE CODE HAS TO BE WRITTEN) _recommended that you do this in android studio_
 
 - In the `android/app/src/main/java/[...]/MainApplication.java`
 
@@ -238,12 +245,11 @@ public class MainApplication extends Application implements ReactApplication {
       }
     });//This will override the default behaviour of displaying the recover activity.
   }
-
 ```
 
-**Modifying Android Native Exception handler UI (CUSTOM ACTIVITY APPROACH (OLD APPROACH).. LEAVING FOR BACKWARD COMPATIBILITY)** 
+**Modifying Android Native Exception handler UI (CUSTOM ACTIVITY APPROACH (OLD APPROACH).. LEAVING FOR BACKWARD COMPATIBILITY)**
 
-(NATIVE CODE HAS TO BE WRITTEN) *recommended that you do this in android studio*
+(NATIVE CODE HAS TO BE WRITTEN) _recommended that you do this in android studio_
 
 - Create an Empty Activity in the `android/app/src/main/java/[...]/`. For example lets say CustomErrorDialog.java
 - Customize your activity to look and behave however you need it to be.
@@ -265,10 +271,9 @@ public class MainApplication extends Application implements ReactApplication {
     ....
     ReactNativeExceptionHandlerModule.replaceErrorScreenActivityClass(YourCustomActivity.class); //This will replace the native error handler popup with your own custom activity.
   }
-
 ```
 
-**Modifying iOS Native Exception handler UI** (NATIVE CODE HAS TO BE WRITTEN) *recommended that you do this in XCode*
+**Modifying iOS Native Exception handler UI** (NATIVE CODE HAS TO BE WRITTEN) _recommended that you do this in XCode_
 
 Unlike Android, in the case of iOS, there is no way to restart the app if it has crashed. Also, during a **Native_Exceptions** the UI becomes quite unstable since the exception occured on the main UI thread. Hence, none of the click or press handlers would work either.
 
@@ -279,7 +284,6 @@ If you noticed the default native exception popup does exactly that. To customiz
 - In XCode, open the file `AppDelegate.m`
 
 ```c
-
 #import "AppDelegate.h"
 
 #import <React/RCTBundleURLProvider.h>
@@ -337,7 +341,6 @@ If you noticed the default native exception popup does exactly that. To customiz
 }
 
 @end
-
 ```
 
 What is this `[ReactNativeExceptionHandler releaseExceptionHold];`?
@@ -350,6 +353,7 @@ To close the app or to remove the UI lockup on exception, we need to call this m
 
 Hence we set a timer of 4 secs and then call the method releaseExceptionHold to quit the app after
 4 secs of showing the popup
+
 ```c
 [NSTimer scheduledTimerWithTimeInterval:4.0
                                  target:[ReactNativeExceptionHandler class]
@@ -396,7 +400,7 @@ setNativeExceptionHandler((errorString) => {
     //You can do something like call an api to report to dev team here
     ...
     ...
-   // When you call setNativeExceptionHandler, react-native-exception-handler sets a  
+   // When you call setNativeExceptionHandler, react-native-exception-handler sets a
    // Native Exception Handler popup which supports restart on error in case of android.
    // In case of iOS, it is not possible to restart the app programmatically, so we just show an error popup and close the app.
    // To customize the popup screen take a look at CUSTOMIZATION section.
@@ -408,11 +412,11 @@ setNativeExceptionHandler((errorString) => {
 This example shows how to use this module to send global errors to the dev team and show a graceful bug dialog to the user on crash !
 
 ```js
-import {Alert} from 'react-native';
-import {BackAndroid} from 'react-native';
-import {setJSExceptionHandler} from 'react-native-exception-handler';
+import { Alert } from "react-native";
+import { BackAndroid } from "react-native";
+import { setJSExceptionHandler } from "react-native-exception-handler";
 
-const reporter = (error) => {
+const reporter = error => {
   // Logic for reporting to devs
   // Example : Log issues to github issues using github apis.
   console.log(error); // sample
@@ -422,18 +426,20 @@ const errorHandler = (e, isFatal) => {
   if (isFatal) {
     reporter(e);
     Alert.alert(
-        'Unexpected error occurred',
-        `
-        Error: ${(isFatal) ? 'Fatal:' : ''} ${e.name} ${e.message}
+      "Unexpected error occurred",
+      `
+        Error: ${isFatal ? "Fatal:" : ""} ${e.name} ${e.message}
 
         We have reported this to our team ! Please close the app and start again!
         `,
-      [{
-        text: 'Close',
-        onPress: () => {
-          BackAndroid.exitApp();
+      [
+        {
+          text: "Close",
+          onPress: () => {
+            BackAndroid.exitApp();
+          }
         }
-      }]
+      ]
     );
   } else {
     console.log(e); // So that we can see it in the ADB logs in case of Android if needed
@@ -442,16 +448,16 @@ const errorHandler = (e, isFatal) => {
 
 setJSExceptionHandler(errorHandler);
 
-setNativeExceptionHandler((errorString) => {
-    //You can do something like call an api to report to dev team here
-    //example
-    // fetch('http://<YOUR API TO REPORT TO DEV TEAM>?error='+errorString);
-    //
+setNativeExceptionHandler(errorString => {
+  //You can do something like call an api to report to dev team here
+  //example
+  // fetch('http://<YOUR API TO REPORT TO DEV TEAM>?error='+errorString);
+  //
 });
-
 ```
 
-*More Examples can be found in the examples folder*
+_More Examples can be found in the examples folder_
+
 - Preserving old handler (thanks to zeh)
 
 # Known issues and fixes:
@@ -460,14 +466,13 @@ setNativeExceptionHandler((errorString) => {
 
 This is specifically occuring when you use [wix library](http://wix.github.io/react-native-navigation/) for navigation along with react-native-exception-handler. Whenever an error occurs, it will recreate the application above the crash screen.
 
-
 **Fix:**
 
- You need to set second parametera as *false* while calling _setNativeExceptionHandler_.
- The second parameter is an android specific field which stands for forceQuitOnError.
- When set to false it doesnt quit the app forcefully on error. In short :
+You need to set second parametera as _false_ while calling _setNativeExceptionHandler_.
+The second parameter is an android specific field which stands for forceQuitOnError.
+When set to false it doesnt quit the app forcefully on error. In short :
 
- Credit goes to **Gustavo Fão Valvassori**
+Credit goes to **Gustavo Fão Valvassori**
 
 ```js
 setNativeExceptionHandler(nativeErrorCallback, false);
@@ -477,8 +482,8 @@ setNativeExceptionHandler(nativeErrorCallback, false);
 
 A lot of frameworks (especially analytics sdk's) implement global exception handlers. In order to keep these frameworks working while using react-native-exception-hanlder, you can pass a boolean value as third argument to `setNativeExceptionHandler(..., ..., true`) what will trigger the execution of the last global handler registered.
 
-
 ## CONTRIBUTORS
+
 - [Atul R](https://github.com/master-atul)
 - [Zeh Fernando](https://github.com/zeh)
 - [Fred Chasen](https://github.com/fchasen)
@@ -494,6 +499,7 @@ A lot of frameworks (especially analytics sdk's) implement global exception hand
 - [Sébastien Krafft](https://github.com/skrafft)
 - [Mark Friedman](https://github.com/mark-friedman)
 - [Damien Solimando](https://github.com/dsolimando)
+- [Jens Kuhr Jørgensen](https://github.com/jenskuhrjorgensen)
 
 ## TESTING NATIVE EXCEPTIONS/ERRORS
 
@@ -503,6 +509,4 @@ To make sure this module works. You can generate a native exception using the mo
 `rn-test-exception-handler` module does only one thing. It raises a **Native_Exceptions**.
 This will help you to verify your customizations or functionality of this module.
 
-
-
 Peace ! ✌🏻🍻