docs(estimote-beacons): typos

src/@ionic-native/plugins/estimote-beacons/index.ts

@@ -1,9 +1,8 @@
 import { Injectable } from '@angular/core';
-import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
+import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
 import { Observable } from 'rxjs/Observable';
 
 export interface EstimoteBeaconRegion {
-
   state?: string;
 
   major: number;
@@ -13,7 +12,6 @@ export interface EstimoteBeaconRegion {
   identifier?: string;
 
   uuid: string;
-
 }
 
 /**
@@ -48,7 +46,6 @@ export interface EstimoteBeaconRegion {
 })
 @Injectable()
 export class EstimoteBeacons extends IonicNativePlugin {
-
   /** Proximity value */
   ProximityUnknown = 0;
 
@@ -124,7 +121,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  requestWhenInUseAuthorization(): Promise<any> { return; }
+  requestWhenInUseAuthorization(): Promise<any> {
+    return;
+  }
 
   /**
    * Ask the user for permission to use location services
@@ -145,7 +144,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  requestAlwaysAuthorization(): Promise<any> { return; }
+  requestAlwaysAuthorization(): Promise<any> {
+    return;
+  }
 
   /**
    * Get the current location authorization status.
@@ -164,7 +165,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  authorizationStatus(): Promise<any> { return; }
+  authorizationStatus(): Promise<any> {
+    return;
+  }
 
   /**
    * Start advertising as a beacon.
@@ -177,16 +180,23 @@ export class EstimoteBeacons extends IonicNativePlugin {
    *   EstimoteBeacons.stopAdvertisingAsBeacon().then((result) => { console.log('Beacon stopped'); });
    * }, 5000);
    * ```
-   * @param uuid {string} UUID string the beacon should advertise (mandatory).
+   * @param {string} uuid UUID string the beacon should advertise (mandatory).
-   * @param major {number} Major value to advertise (mandatory).
+   * @param {number} major Major value to advertise (mandatory).
-   * @param minor {number} Minor value to advertise (mandatory).
+   * @param {number} minor Minor value to advertise (mandatory).
-   * @param regionId {string} Identifier of the region used to advertise (mandatory).
+   * @param {string} regionId Identifier of the region used to advertise (mandatory).
    * @returns {Promise<any>}
    */
   @Cordova({
     clearFunction: 'stopAdvertisingAsBeacon'
   })
-  startAdvertisingAsBeacon(uuid: string, major: number, minor: number, regionId: string): Promise<any> { return; }
+  startAdvertisingAsBeacon(
+    uuid: string,
+    major: number,
+    minor: number,
+    regionId: string
+  ): Promise<any> {
+    return;
+  }
 
   /**
    * Stop advertising as a beacon.
@@ -202,7 +212,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  stopAdvertisingAsBeacon(): Promise<any> { return; }
+  stopAdvertisingAsBeacon(): Promise<any> {
+    return;
+  }
 
   /**
    * Enable analytics.
@@ -213,16 +225,18 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * ```
    * EstimoteBeacons.enableAnalytics(true).then(() => { console.log('Analytics enabled'); });
    * ```
-   * @param enable {number} Boolean value to turn analytics on or off (mandatory).
+   * @param {number} enable Boolean value to turn analytics on or off (mandatory).
    * @returns {Promise<any>}
    */
   @Cordova()
-  enableAnalytics(enable: boolean): Promise<any> { return; }
+  enableAnalytics(enable: boolean): Promise<any> {
+    return;
+  }
 
   /**
-  * Test if analytics is enabled.
+   * Test if analytics is enabled.
-  *
+   *
-  * @see {@link http://estimote.github.io/iOS-SDK/Classes/ESTConfig.html|Further details}
+   * @see {@link http://estimote.github.io/iOS-SDK/Classes/ESTConfig.html|Further details}
    *
    * @usage
    * ```
@@ -231,12 +245,14 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  isAnalyticsEnabled(): Promise<any> { return; }
+  isAnalyticsEnabled(): Promise<any> {
+    return;
+  }
 
   /**
-  * Test if App ID and App Token is set.
+   * Test if App ID and App Token is set.
-  *
+   *
-  * @see {@link http://estimote.github.io/iOS-SDK/Classes/ESTConfig.html|Further details}
+   * @see {@link http://estimote.github.io/iOS-SDK/Classes/ESTConfig.html|Further details}
    *
    * @usage
    * ```
@@ -245,23 +261,27 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  isAuthorized(): Promise<any> { return; }
+  isAuthorized(): Promise<any> {
+    return;
+  }
 
   /**
-  * Set App ID and App Token.
+   * Set App ID and App Token.
-  *
+   *
-  * @see {@link http://estimote.github.io/iOS-SDK/Classes/ESTConfig.html|Further details}
+   * @see {@link http://estimote.github.io/iOS-SDK/Classes/ESTConfig.html|Further details}
    *
    * @usage
    * ```
    * EstimoteBeacons.setupAppIDAndAppToken('MyAppID', 'MyAppToken').then(() => { console.log('AppID and AppToken configured!'); });
    * ```
-   * @param appID {string} The App ID (mandatory).
+   * @param {string} appID The App ID (mandatory).
-   * @param appToken {string} The App Token (mandatory).
+   * @param {string} appToken The App Token (mandatory).
    * @returns {Promise<any>}
    */
   @Cordova()
-  setupAppIDAndAppToken(appID: string, appToken: string): Promise<any> { return; }
+  setupAppIDAndAppToken(appID: string, appToken: string): Promise<any> {
+    return;
+  }
 
   /**
    * Start scanning for all nearby beacons using CoreBluetooth (no region object is used).
@@ -282,7 +302,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
     observable: true,
     clearFunction: 'stopEstimoteBeaconDiscovery'
   })
-  startEstimoteBeaconDiscovery(): Observable<any> { return; }
+  startEstimoteBeaconDiscovery(): Observable<any> {
+    return;
+  }
 
   /**
    * Stop CoreBluetooth scan. Available on iOS.
@@ -299,7 +321,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  stopEstimoteBeaconDiscovery(): Promise<any> { return; }
+  stopEstimoteBeaconDiscovery(): Promise<any> {
+    return;
+  }
 
   /**
    * Start ranging beacons. Available on iOS and Android.
@@ -314,7 +338,7 @@ export class EstimoteBeacons extends IonicNativePlugin {
    *   EstimoteBeacons.stopRangingBeaconsInRegion(region).then(() => { console.log('scan stopped'); });
    * }, 5000);
    * ```
-   * @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory).
+   * @param {EstimoteBeaconRegion} region Dictionary with region properties (mandatory).
    * @returns {Observable<any>} Returns an Observable that notifies of each beacon discovered.
    */
   @Cordova({
@@ -322,7 +346,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
     clearFunction: 'stopRangingBeaconsInRegion',
     clearWithArgs: true
   })
-  startRangingBeaconsInRegion(region: EstimoteBeaconRegion): Observable<any> { return; }
+  startRangingBeaconsInRegion(region: EstimoteBeaconRegion): Observable<any> {
+    return;
+  }
 
   /**
    * Stop ranging beacons. Available on iOS and Android.
@@ -337,15 +363,17 @@ export class EstimoteBeacons extends IonicNativePlugin {
    *   EstimoteBeacons.stopRangingBeaconsInRegion(region).then(() => { console.log('scan stopped'); });
    * }, 5000);
    * ```
-   * @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory).
+   * @param {EstimoteBeaconRegion} region Dictionary with region properties (mandatory).
    * @returns {Promise<any>}
    */
   @Cordova()
-  stopRangingBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
+  stopRangingBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> {
+    return;
+  }
 
   /**
    * Start ranging secure beacons. Available on iOS.
-   * This function has the same parameters/behaviour as
+   * This function has the same parameters/behavior as
    * {@link EstimoteBeacons.startRangingBeaconsInRegion}.
    * To use secure beacons set the App ID and App Token using
    * {@link EstimoteBeacons.setupAppIDAndAppToken}.
@@ -356,16 +384,22 @@ export class EstimoteBeacons extends IonicNativePlugin {
     clearFunction: 'stopRangingSecureBeaconsInRegion',
     clearWithArgs: true
   })
-  startRangingSecureBeaconsInRegion(region: EstimoteBeaconRegion): Observable<any> { return; }
+  startRangingSecureBeaconsInRegion(
+    region: EstimoteBeaconRegion
+  ): Observable<any> {
+    return;
+  }
 
   /**
    * Stop ranging secure beacons. Available on iOS.
-   * This function has the same parameters/behaviour as
+   * This function has the same parameters/behavior as
    * {@link EstimoteBeacons.stopRangingBeaconsInRegion}.
    * @returns {Promise<any>}
    */
   @Cordova()
-  stopRangingSecureBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
+  stopRangingSecureBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> {
+    return;
+  }
 
   /**
    * Start monitoring beacons. Available on iOS and Android.
@@ -377,8 +411,8 @@ export class EstimoteBeacons extends IonicNativePlugin {
    *   console.log('Region state: ' + JSON.stringify(state));
    * });
    * ```
-   * @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory).
+   * @param {EstimoteBeaconRegion} region Dictionary with region properties (mandatory).
-   * @param [notifyEntryStateOnDisplay=false] {boolean} Set to true to detect if you
+   * @param {boolean} [notifyEntryStateOnDisplay] Set to true to detect if you
    * are inside a region when the user turns display on, see
    * {@link https://developer.apple.com/library/prerelease/ios/documentation/CoreLocation/Reference/CLBeaconRegion_class/index.html#//apple_ref/occ/instp/CLBeaconRegion/notifyEntryStateOnDisplay|iOS documentation}
    * for further details (iOS only).
@@ -391,7 +425,12 @@ export class EstimoteBeacons extends IonicNativePlugin {
     successIndex: 1,
     errorIndex: 2
   })
-  startMonitoringForRegion(region: EstimoteBeaconRegion, notifyEntryStateOnDisplay: boolean): Observable<any> { return; }
+  startMonitoringForRegion(
+    region: EstimoteBeaconRegion,
+    notifyEntryStateOnDisplay: boolean
+  ): Observable<any> {
+    return;
+  }
 
   /**
    * Stop monitoring beacons. Available on iOS and Android.
@@ -401,21 +440,23 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * let region: EstimoteBeaconRegion = {} // Empty region matches all beacons.
    * EstimoteBeacons.stopMonitoringForRegion(region).then(() => { console.log('monitoring is stopped'); });
    * ```
-   * @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory).
+   * @param {EstimoteBeaconRegion} region Dictionary with region properties (mandatory).
    * @returns {Promise<any>}
    */
   @Cordova()
-  stopMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
+  stopMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> {
+    return;
+  }
 
   /**
    * Start monitoring secure beacons. Available on iOS.
-   * This function has the same parameters/behaviour as
+   * This function has the same parameters/behavior as
    * EstimoteBeacons.startMonitoringForRegion.
    * To use secure beacons set the App ID and App Token using
    * {@link EstimoteBeacons.setupAppIDAndAppToken}.
    * @see {@link EstimoteBeacons.startMonitoringForRegion}
-   * @param region {EstimoteBeaconRegion} Region
+   * @param {EstimoteBeaconRegion} region Region
-   * @param notifyEntryStateOnDisplay {boolean}
+   * @param {boolean} notifyEntryStateOnDisplay
    * @returns {Observable<any>}
    */
   @Cordova({
@@ -425,17 +466,24 @@ export class EstimoteBeacons extends IonicNativePlugin {
     successIndex: 1,
     errorIndex: 2
   })
-  startSecureMonitoringForRegion(region: EstimoteBeaconRegion, notifyEntryStateOnDisplay: boolean): Observable<any> { return; }
+  startSecureMonitoringForRegion(
+    region: EstimoteBeaconRegion,
+    notifyEntryStateOnDisplay: boolean
+  ): Observable<any> {
+    return;
+  }
 
   /**
-  * Stop monitoring secure beacons. Available on iOS.
+   * Stop monitoring secure beacons. Available on iOS.
-  * This function has the same parameters/behaviour as
+   * This function has the same parameters/behavior as
-  * {@link EstimoteBeacons.stopMonitoringForRegion}.
+   * {@link EstimoteBeacons.stopMonitoringForRegion}.
-  * @param region {EstimoteBeaconRegion} Region
+   * @param {EstimoteBeaconRegion} region Region
-  * @returns {Promise<any>}
+   * @returns {Promise<any>}
-  */
+   */
   @Cordova()
-  stopSecureMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
+  stopSecureMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> {
+    return;
+  }
 
   /**
    * Connect to Estimote Beacon. Available on Android.
@@ -451,11 +499,13 @@ export class EstimoteBeacons extends IonicNativePlugin {
    *     minor: 1
    *   });
    * ```
-   * @param beacon {Beacon} Beacon to connect to.
+   * @param {Beacon} beacon Beacon to connect to.
    * @returns {Promise<any>}
    */
   @Cordova()
-  connectToBeacon(beacon: any): Promise<any> { return; }
+  connectToBeacon(beacon: any): Promise<any> {
+    return;
+  }
 
   /**
    * Disconnect from connected Estimote Beacon. Available on Android.
@@ -467,7 +517,9 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * @returns {Promise<any>}
    */
   @Cordova()
-  disconnectConnectedBeacon(): Promise<any> { return; }
+  disconnectConnectedBeacon(): Promise<any> {
+    return;
+  }
 
   /**
    * Write proximity UUID to connected Estimote Beacon. Available on Android.
@@ -477,11 +529,13 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * // Example that writes constant ESTIMOTE_PROXIMITY_UUID
    * EstimoteBeacons.writeConnectedProximityUUID(ESTIMOTE_PROXIMITY_UUID);
    *
-   * @param uuid {string} String to write as new UUID
+   * @param {string} uuid String to write as new UUID
    * @returns {Promise<any>}
    */
   @Cordova()
-  writeConnectedProximityUUID(uuid: any): Promise<any> { return; }
+  writeConnectedProximityUUID(uuid: any): Promise<any> {
+    return;
+  }
 
   /**
    * Write major to connected Estimote Beacon. Available on Android.
@@ -491,11 +545,13 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * // Example that writes 1
    * EstimoteBeacons.writeConnectedMajor(1);
    *
-   * @param major {number} number to write as new major
+   * @param {number} major number to write as new major
    * @returns {Promise<any>}
    */
   @Cordova()
-  writeConnectedMajor(major: number): Promise<any> { return; }
+  writeConnectedMajor(major: number): Promise<any> {
+    return;
+  }
 
   /**
    * Write minor to connected Estimote Beacon. Available on Android.
@@ -505,10 +561,11 @@ export class EstimoteBeacons extends IonicNativePlugin {
    * // Example that writes 1
    * EstimoteBeacons.writeConnectedMinor(1);
    *
-   * @param minor {number} number to write as new minor
+   * @param {number} minor number to write as new minor
    * @returns {Promise<any>}
    */
   @Cordova()
-  writeConnectedMinor(minor: number): Promise<any> { return; }
+  writeConnectedMinor(minor: number): Promise<any> {
-
+    return;
+  }
 }