github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-01-19 08:32:52 +08:00
Code Issues Projects Releases Wiki Activity

docs(card-io): fix jsdoc

Browse Source
This commit is contained in:
Daniel 2018-04-08 20:44:06 +02:00
parent 1e8626c435
commit 62241105c8
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/@ionic-native/plugins/card-io/index.ts
View File

@ -1,8 +1,7 @@
import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
export interface CardIOOptions {
/**
* Set to true to require expiry date
*/
@ -82,11 +81,9 @@ export interface CardIOOptions {
* Once a card image has been captured but before it has been processed, this value will determine whether to continue processing as usual.
*/
supressScan?: boolean;
}
export interface CardIOResponse {
/**
* Card type
*/
@ -126,7 +123,6 @@ export interface CardIOResponse {
* Cardholder name
*/
cardholderName: string;
}
/**
@ -173,7 +169,6 @@ export interface CardIOResponse {
})
@Injectable()
export class CardIO extends IonicNativePlugin {
/**
* Check whether card scanning is currently available. (May vary by
* device, OS version, network connectivity, etc.)
@ -181,21 +176,26 @@ export class CardIO extends IonicNativePlugin {
* @returns {Promise<boolean>}
*/
@Cordova()
canScan(): Promise<boolean> { return; }
canScan(): Promise<boolean> {
return;
}
/**
* Scan a credit card with card.io.
* @param {CardIOOptions} options Options for configuring the plugin
* @param {CardIOOptions} [options] Options for configuring the plugin
* @returns {Promise<any>}
*/
@Cordova()
scan(options?: CardIOOptions): Promise<CardIOResponse> { return; }
scan(options?: CardIOOptions): Promise<CardIOResponse> {
return;
}
/**
* Retrieve the version of the card.io library. Useful when contacting support.
* @returns {Promise<string>}
*/
@Cordova()
version(): Promise<string> { return; }
version(): Promise<string> {
return;
}
}