Merge remote-tracking branch 'origin/master'

Author: Salakar

docs/api/analytics.md

@@ -19,70 +19,62 @@ own app. The Firebase SDK includes a number of pre-set events which are automati
   'user_engagement',
 ```
 
-#### logEvent(event: string, params?: Object)
+#### `logEvent(event: string, params?: Object): void`
 
-Log a custom event with optional params. Can be synchronous or return a Promise 
+Log a custom event with optional params.
 
 ```javascript
-firestack.analytics()
-  .logEvent('clicked_advert', { id: 1337 })
-  .then(() => {
-    console.log('Event has been logged successfully'); 
-  });
+firestack.analytics().logEvent('clicked_advert', { id: 1337 });
 ```
 
-#### setAnalyticsCollectionEnabled(enabled: boolean)
+#### `setAnalyticsCollectionEnabled(enabled: boolean): void`
 
 Sets whether analytics collection is enabled for this app on this device.
 
 ```javascript
-firestack.analytics()
-  .setAnalyticsCollectionEnabled(false);
+firestack.analytics().setAnalyticsCollectionEnabled(false);
 ```
 
-#### setCurrentScreen(screenName: string, screenClassOverride: string)
+#### `setCurrentScreen(screenName: string, screenClassOverride?: string): void`
 
 Sets the current screen name, which specifies the current visual context in your app.
 
+> Whilst `screenClassOverride` is optional, it is recommended it is always sent as your current class name, for example on Android it will always show as 'MainActivity' if not specified.
+
 ```javascript
-firestack.analytics()
-  .setCurrentScreen('user_profile');
+firestack.analytics().setCurrentScreen('user_profile');
 ```
 
-#### setMinimumSessionDuration(miliseconds: number)
+#### `setMinimumSessionDuration(miliseconds: number): void`
 
 Sets the minimum engagement time required before starting a session. The default value is 10000 (10 seconds).
 
 ```javascript
-firestack.analytics()
-  .setMinimumSessionDuration(15000);
+firestack.analytics().setMinimumSessionDuration(15000);
 ```
 
-#### setSessionTimeoutDuration(miliseconds: number)
+#### `setSessionTimeoutDuration(miliseconds: number): void`
 
 Sets the duration of inactivity that terminates the current session. The default value is 1800000 (30 minutes).
 
 ```javascript
-firestack.analytics()
-  .setSessionTimeoutDuration(900000);
+firestack.analytics().setSessionTimeoutDuration(900000);
 ```
 
-#### setUserId(id: string)
+#### `setUserId(id: string): void`
 
 Gives a user a uniqiue identificaition.
 
 ```javascript
 const id = firestack.auth().currentUser.uid;
 
-firestack.analytics()
-  .setUserId(id);
+firestack.analytics().setUserId(id);
 ```
 
-#### setUserProperty(name: string, value: string)
+#### `setUserProperty(name: string, value: string): void`
 
 Sets a key/value pair of data on the current user.
 
 ```javascript
-firestack.analytics()
-  .setUserProperty('nickname', 'foobar');
+firestack.analytics().setUserProperty('nickname', 'foobar');
 ```

docs/api/authentication.md

@@ -4,36 +4,36 @@ Firestack handles authentication for us out of the box, both with email/password
 
 > Android requires the Google Play services to installed for authentication to function.
 
-## Local Auth
+#### [`onAuthStateChanged(event: Function): Function`](https://firebase.google.com/docs/reference/js/firebase.auth.Auth#onAuthStateChanged)
 
-#### [onAuthStateChanged(event: Function)](https://firebase.google.com/docs/reference/js/firebase.auth.Auth#onAuthStateChanged)
-
-Listen for changes in the users auth state (logging in and out).
+Listen for changes in the users auth state (logging in and out). This method returns a unsubscribe function to stop listening to events. Always ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.
 
 ```javascript
-firestack.auth().onAuthStateChanged((evt) => {
-  // evt is the authentication event, it contains an `error` key for carrying the
-  // error message in case of an error and a `user` key upon successful authentication
-  if (!evt.authenticated) {
-    // There was an error or there is no user
-    console.error(evt.error)
-  } else {
-    // evt.user contains the user details
-    console.log('User details', evt.user);
-  }
-})
-.then(() => console.log('Listening for authentication changes'))
-```
+class Example extends React.Component {
 
-#### offAuthStateChanged()
-
-Remove the `onAuthStateChanged` listener. 
-This is important to release resources from our app when we don't need to hold on to the listener any longer.
+  constructor() {
+    super();
+    this.unsubscribe = null;
+  }
+  
+  componentDidMount() {
+    this.unsubscribe = firebase.auth().onAuthStateChanged(function(user) {
+      if (user) {
+        // User is signed in.
+      }
+    });
+  }
+  
+  componentWillUnmount() {
+    if (this.listener) {
+      this.unsubscribe();
+    }
+  }
 
-```javascript
-firestack.auth().offAuthStateChanged()
+}
 ```
 
+
 #### [createUserWithEmailAndPassword(email: string, password: string)](https://firebase.google.com/docs/reference/js/firebase.auth.Auth#createUserWithEmailAndPassword)
 
 We can create a user by calling the `createUserWithEmailAndPassword()` function.