Add docs for dispatch functions

README.md

@@ -408,6 +408,28 @@ Sets tracker currency property, see [Currency Codes](https://developers.google.c
 tracker.setCurrency('EUR');
 ```
 
+### dispatch()
+
+This function lets you manually dispatch all hits which are queued.
+Use this function sparingly, as it will normally happen automatically as a batch.
+
+* returns Promise
+
+```javascript
+tracker.dispatch().then((done) => console.log("Dispatch is done: ", done));
+```
+
+### dispatchWithTimeout()
+
+* **timeout (optional):** Number, in ms
+
+The same as `dispatch()`, but also gives you the ability to time out the Promise in case dispatch takes too long.
+
+* returns Promise
+
+```javascript
+tracker.dispatchWithTimeout(10000).then((done) => console.log("Dispatch is done: ", done));
+```
 ## GoogleAnalyticsSettings API
 
 Settings are applied across all trackers.

index.d.ts

@@ -260,6 +260,22 @@ declare module "react-native-google-analytics-bridge" {
          * @param {String} screenName The current screen which the session started on
          */
         createNewSession(screenName: string): void
+
+        /**
+         * This function lets you manually dispatch all hits which are queued.
+         * Use this function sparingly, as it will normally happen automatically
+         * as a batch.
+         * @returns {Promise<boolean>} Returns when done
+         */
+        dispatch(): Promise<boolean>
+
+        /**
+         * The same as dispatch(), but also gives you the ability to time out
+         * the Promise in case dispatch takes too long.
+         * @param {Number} timeout The timeout. Default value is 15 sec.
+         * @returns {Promise<boolean>} Returns when done or timed out
+         */
+        dispatchWithTimeout(timeout: number = -1): Promise<boolean>
     }
 
     /**

src/GoogleAnalyticsTracker.js

@@ -251,10 +251,22 @@ export class GoogleAnalyticsTracker {
     GoogleAnalyticsBridge.createNewSession(this.id, screenName);
   }
 
+  /**
+   * This function lets you manually dispatch all hits which are queued.
+   * Use this function sparingly, as it will normally happen automatically
+   * as a batch.
+   * @returns {Promise<boolean>} Returns when done
+   */
   dispatch() {
     return GoogleAnalyticsBridge.dispatch();
   }
 
+  /**
+   * The same as dispatch(), but also gives you the ability to time out
+   * the Promise in case dispatch takes too long.
+   * @param {Number} timeout The timeout. Default value is 15 sec.
+   * @returns {Promise<boolean>} Returns when done or timed out
+   */
   dispatchWithTimeout(timeout = -1) {
     if (timeout < 0) {
       return GoogleAnalyticsBridge.dispatch();