update documentation

Author: Scott Farley

lib/events.js

@@ -4,9 +4,10 @@ var request = require('request');
 var crypto = require('crypto');
 
 /**
- * varruct a new mapbox event client to send interaction events to the mapbox event service
+ * Construct a new mapbox event client to send interaction events to the mapbox event service
  * @param {Object} options options with which to create the service
  * @param {String} options.accessToken the mapbox access token to make requests
+ * @private
  */
 function MapboxEventManager(options){
   this.origin = options.origin || 'https://api.mapbox.com';
@@ -33,8 +34,10 @@ MapboxEventManager.prototype = {
   /**
      * Send a search.select event to the mapbox events service
      * This event marks the array index of the item selected by the user out of the array of possible options
+     * @private
      * @param {Object} selected the geojson feature selected by the user
      * @param {Object} geocoder a mapbox-gl-geocoder instance
+     * @param {Function} callback a callback function to invoke once the event has been sent (optional)
      * @returns {Promise}
      */
   select: function(selected, geocoder, callback){
@@ -53,7 +56,9 @@ MapboxEventManager.prototype = {
   /**
      * Send a search-start event to the mapbox events service
      * This turnstile event marks when a user starts a new search
+     * @private
      * @param {Object} geocoder a mapbox-gl-geocoder instance
+     * @param {Function} callback 
      * @returns {Promise}
      */
   start: function(geocoder, callback){
@@ -66,7 +71,7 @@ MapboxEventManager.prototype = {
      * 
      * The event is skipped if the instance is not enabled to send logging events
      * 
-     * 
+     * @private
      * @param {Object} payload the http POST body of the event
      * @returns {Promise}
      */
@@ -82,7 +87,11 @@ MapboxEventManager.prototype = {
       if (callback) return callback();
     })
   },
-
+  /**
+   * Get http request options
+   * @private
+   * @param {*} payload 
+   */
   getRequestOptions: function(payload){
     var options = {
       // events must be sent with POST
@@ -102,6 +111,7 @@ MapboxEventManager.prototype = {
   /**
      * Get the event payload to send to the events service
      * Most payload properties are shared across all events
+     * @private
      * @param {String} event the name of the event to send to the events service. Valid options are 'search.start', 'search.select', 'search.feedback'.
      * @param {Object} geocoder a mapbox-gl-geocoder instance 
      * @returns {Object} an event payload 
@@ -135,6 +145,7 @@ MapboxEventManager.prototype = {
   /**
      * Wraps the request function for easier testing
      * Make an http request and invoke a callback
+     * @private
      * @param {Object} opts options describing the http request to be made
      * @param {Function} callback the callback to invoke when the http request is completed
      */
@@ -147,6 +158,7 @@ MapboxEventManager.prototype = {
   /**
      * Handle an error that occurred while making a request
      * @param {Object} err an error instance to log
+     * @private
      */
   handleError: function(err, callback){
     if (callback) return callback(err);
@@ -155,6 +167,7 @@ MapboxEventManager.prototype = {
   /**
      * Generate a session ID to be returned with all of the searches made by this geocoder instance
      * ID is random and cannot be tracked across sessions
+     * @private
      */
   generateSessionID: function(){
     var sha = crypto.createHash('sha256');
@@ -164,13 +177,15 @@ MapboxEventManager.prototype = {
 
   /**
      * Get a user agent string to send with the request to the events service
+     * @private
      */
   getUserAgent: function(){
     return 'mapbox-gl-geocoder.' + this.version + "." + navigator.userAgent;
   },
 
   /**
      * Get the 0-based numeric index of the item that the user selected out of the list of options
+     * @private
      * @param {Object} selected the geojson feature selected by the user
      * @param {Object} geocoder a Mapbox-GL-Geocoder instance
      * @returns {Number} the index of the selected result
@@ -188,6 +203,7 @@ MapboxEventManager.prototype = {
   /**
      * Check whether events should be logged
      * Clients using a localGeocoder or an origin other than mapbox should not have events logged
+     * @private
      */
   shouldEnableLogging: function(options){
     if (!this.origin.includes('api.mapbox.com')) return false;