mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-04-13 00:00:10 +08:00
style(): unify docs and spacing (#1448)
* typo(barcode-scanner): fixe circle lint error
* typo(docs): Unified the documentations
In some plugins the typescript markup was missing.
I also unified the console.log string from console.log("hello") to console.log('Hello') so any plugin page look the same.
This commit is contained in:
@@ -16,7 +16,7 @@ declare let window: any;
|
||||
* This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems.
|
||||
*
|
||||
* @usage
|
||||
* ```
|
||||
* ```typescript
|
||||
* import { NFC, Ndef } from '@ionic-native/nfc';
|
||||
*
|
||||
* constructor(private nfc: NFC, private ndef: Ndef) { }
|
||||
@@ -34,9 +34,9 @@ declare let window: any;
|
||||
pluginRef: 'nfc',
|
||||
repo: 'https://github.com/chariotsolutions/phonegap-nfc'
|
||||
})
|
||||
/**
|
||||
*@{ NFC } class methods
|
||||
*/
|
||||
/**
|
||||
*@{ NFC } class methods
|
||||
*/
|
||||
@Injectable()
|
||||
export class NFC extends IonicNativePlugin {
|
||||
/**
|
||||
@@ -52,7 +52,7 @@ export class NFC extends IonicNativePlugin {
|
||||
clearFunction: 'removeNdefListener',
|
||||
clearWithArgs: true
|
||||
})
|
||||
addNdefListener(onSuccess?: Function, onFailure?: Function): Observable<any> {return; }
|
||||
addNdefListener(onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
|
||||
|
||||
/**
|
||||
* Registers an event listener for tags matching any tag type.
|
||||
@@ -67,7 +67,7 @@ export class NFC extends IonicNativePlugin {
|
||||
clearFunction: 'removeTagDiscoveredListener',
|
||||
clearWithArgs: true
|
||||
})
|
||||
addTagDiscoveredListener(onSuccess?: Function, onFailure?: Function): Observable<any> {return; }
|
||||
addTagDiscoveredListener(onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
|
||||
|
||||
/**
|
||||
* Registers an event listener for NDEF tags matching a specified MIME type.
|
||||
@@ -83,7 +83,7 @@ export class NFC extends IonicNativePlugin {
|
||||
clearFunction: 'removeMimeTypeListener',
|
||||
clearWithArgs: true
|
||||
})
|
||||
addMimeTypeListener(mimeType: string, onSuccess?: Function, onFailure?: Function): Observable<any> {return; }
|
||||
addMimeTypeListener(mimeType: string, onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
|
||||
|
||||
/**
|
||||
* Registers an event listener for formatable NDEF tags.
|
||||
@@ -96,7 +96,7 @@ export class NFC extends IonicNativePlugin {
|
||||
successIndex: 0,
|
||||
errorIndex: 3
|
||||
})
|
||||
addNdefFormatableListener(onSuccess?: Function, onFailure?: Function): Observable<any> {return; }
|
||||
addNdefFormatableListener(onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
|
||||
|
||||
/**
|
||||
* Writes an NdefMessage(array of ndef records) to a NFC tag.
|
||||
@@ -104,13 +104,13 @@ export class NFC extends IonicNativePlugin {
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
write(message: any[]): Promise<any> {return; }
|
||||
write(message: any[]): Promise<any> { return; }
|
||||
/**
|
||||
* Makes a NFC tag read only. **Warning** this is permanent.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
makeReadyOnly(): Promise<any> {return; }
|
||||
makeReadyOnly(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Shares an NDEF Message(array of ndef records) via peer-to-peer.
|
||||
@@ -118,20 +118,20 @@ export class NFC extends IonicNativePlugin {
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
share(message: any[]): Promise<any> {return; }
|
||||
share(message: any[]): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Stop sharing NDEF data via peer-to-peer.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
unshare(): Promise<any> {return; }
|
||||
unshare(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Erase a NDEF tag
|
||||
*/
|
||||
@Cordova()
|
||||
erase(): Promise<any> {return; }
|
||||
erase(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Send a file to another device via NFC handover.
|
||||
@@ -139,28 +139,28 @@ export class NFC extends IonicNativePlugin {
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
handover(uris: string[]): Promise<any> {return; }
|
||||
handover(uris: string[]): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Stop sharing NDEF data via NFC handover.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
stopHandover(): Promise<any> {return; }
|
||||
stopHandover(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Opens the device's NFC settings.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
showSettings(): Promise<any> {return; }
|
||||
showSettings(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Check if NFC is available and enabled on this device.
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
enabled(): Promise<any> {return; }
|
||||
enabled(): Promise<any> { return; }
|
||||
/**
|
||||
* @{ NFC } class utility methods
|
||||
* for use with
|
||||
@@ -171,14 +171,14 @@ export class NFC extends IonicNativePlugin {
|
||||
* @returns {string}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
bytesToString(bytes: number[]): string {return; }
|
||||
bytesToString(bytes: number[]): string { return; }
|
||||
/**
|
||||
* Convert string to byte array.
|
||||
* @param str {string}
|
||||
* @returns {number[]}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
stringToBytes(str: string): number[] {return; };
|
||||
stringToBytes(str: string): number[] { return; };
|
||||
/**
|
||||
* Convert byte array to hex string
|
||||
*
|
||||
@@ -186,7 +186,7 @@ export class NFC extends IonicNativePlugin {
|
||||
* @returns {string}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
bytesToHexString(bytes: number[]): string {return; };
|
||||
bytesToHexString(bytes: number[]): string { return; };
|
||||
|
||||
}
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user