mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-01-19 16:52:53 +08:00
51 lines
1.5 KiB
Plaintext
51 lines
1.5 KiB
Plaintext
/**
|
|
* This is a template for new plugin wrappers
|
|
*
|
|
* TODO:
|
|
* - Add/Change information below
|
|
* - Document usage (importing, executing main functionality)
|
|
* - Remove any imports that you are not using
|
|
* - Add this file to /src/index.ts (follow style of other plugins)
|
|
* - Remove all the comments included in this template, EXCEPT the @Plugin wrapper docs.
|
|
* - Remove this note
|
|
*
|
|
*/
|
|
import { Plugin, Cordova, CordovaProperty, CordovaInstance, InstanceProperty } from './plugin';
|
|
import { Observable } from 'rxjs/Observable';
|
|
|
|
/**
|
|
* @name PluginName
|
|
* @description
|
|
* This plugin does something
|
|
*
|
|
* @usage
|
|
* ```
|
|
* import { PluginName } from 'ionic-native';
|
|
*
|
|
* PluginName.functionName('Hello', 123)
|
|
* .then((something: any) => doSomething(something))
|
|
* .catch((error: any) => console.log(error));
|
|
*
|
|
* ```
|
|
*/
|
|
@Plugin({
|
|
plugin: '', // npm package name, example: cordova-plugin-camera
|
|
pluginRef: '', // the variable reference to call the plugin, example: navigator.geolocation
|
|
repo: '', // the github repository URL for the plugin
|
|
install: '' // OPTIONAL install command, in case the plugin requires variables
|
|
})
|
|
export class PluginName {
|
|
|
|
/**
|
|
* This function does something
|
|
* @param arg1 {string} Some param to configure something
|
|
* @param arg2 {number} Another param to configure something
|
|
* @return {Promise<any>} Returns a promise that resolves when something happens
|
|
*/
|
|
@Cordova()
|
|
static functionName(arg1: string, arg2: number): Promise<any> {
|
|
return; // We add return; here to avoid any IDE / Compiler errors
|
|
}
|
|
|
|
}
|