fix(serial): Serial.requestPermission() options are optional (#1128)

danielsogl · Mar 2, 2017 · da72500 · da72500
1 parent 0c466d9
commit da72500
Showing 1 changed file with 4 additions and 8 deletions.
diff --git a/src/plugins/serial.ts b/src/plugins/serial.ts
@@ -23,13 +23,9 @@ export interface SerialOpenOptions {
  * ```
  * import { Serial } from 'ionic-native';
  *
- * Serial.requestPermission({
- *   vid: '0403',
- *   pid: '6001',
- *   driver: 'FtdiSerialDriver'
- * }).then(() => {
+ * Serial.requestPermission().then(() => {
  *   Serial.open({
- *     baudRate: 38400
+ *     baudRate: 9800
  *   }).then(() => {
  *     console.log('Serial connection opened');
  *   });
@@ -49,11 +45,11 @@ export class Serial {
   /**
    * Request permission to connect to a serial device
    *
-   * @param options {SerialPermissionOptions} Options used to request serial permissions
+   * @param options {SerialPermissionOptions} Options used to request serial permissions for an unknown device
    * @return {Promise<any>} Returns a promise that resolves when permissions are granted
    */
   @Cordova()
-  static requestPermission(options: SerialPermissionOptions): Promise<any> { return; }
+  static requestPermission(options?: SerialPermissionOptions): Promise<any> { return; }
 
   /**
    * Open connection to a serial device