mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-07 23:03:19 +08:00
docs(plugin): set docs to private
to hide in ionic-site
This commit is contained in:
parent
1e259da375
commit
9293689649
@ -8,13 +8,29 @@ declare var $q;
|
|||||||
|
|
||||||
import {Observable} from 'rxjs/Observable';
|
import {Observable} from 'rxjs/Observable';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private
|
||||||
|
* @param pluginRef
|
||||||
|
* @returns {null|*}
|
||||||
|
*/
|
||||||
export const getPlugin = function(pluginRef: string): any {
|
export const getPlugin = function(pluginRef: string): any {
|
||||||
return get(window, pluginRef);
|
return get(window, pluginRef);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private
|
||||||
|
* @param pluginRef
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
export const isInstalled = function(pluginRef: string): boolean {
|
export const isInstalled = function(pluginRef: string): boolean {
|
||||||
return !!getPlugin(pluginRef);
|
return !!getPlugin(pluginRef);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private
|
||||||
|
* @param pluginObj
|
||||||
|
* @param method
|
||||||
|
*/
|
||||||
export const pluginWarn = function(pluginObj: any, method: string) {
|
export const pluginWarn = function(pluginObj: any, method: string) {
|
||||||
var pluginName = pluginObj.name;
|
var pluginName = pluginObj.name;
|
||||||
var plugin = pluginObj.plugin;
|
var plugin = pluginObj.plugin;
|
||||||
@ -25,6 +41,12 @@ export const pluginWarn = function(pluginObj: any, method: string) {
|
|||||||
}
|
}
|
||||||
console.warn('Install the ' + pluginName + ' plugin: \'cordova plugin add ' + plugin + '\'');
|
console.warn('Install the ' + pluginName + ' plugin: \'cordova plugin add ' + plugin + '\'');
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private
|
||||||
|
* @param pluginName
|
||||||
|
* @param method
|
||||||
|
*/
|
||||||
export const cordovaWarn = function(pluginName: string, method: string) {
|
export const cordovaWarn = function(pluginName: string, method: string) {
|
||||||
if(method) {
|
if(method) {
|
||||||
console.warn('Native: tried calling ' + pluginName + '.' + method + ', but Cordova is not available. Make sure to include cordova.js or run in a device/simulator');
|
console.warn('Native: tried calling ' + pluginName + '.' + method + ', but Cordova is not available. Make sure to include cordova.js or run in a device/simulator');
|
||||||
@ -119,6 +141,13 @@ function wrapObservable(pluginObj:any, methodName:string, args:any[], opts:any =
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private
|
||||||
|
* @param pluginObj
|
||||||
|
* @param methodName
|
||||||
|
* @param opts
|
||||||
|
* @returns {function(...[any]): (undefined|*|Observable|*|*)}
|
||||||
|
*/
|
||||||
export const wrap = function(pluginObj:any, methodName:string, opts:any = {}) {
|
export const wrap = function(pluginObj:any, methodName:string, opts:any = {}) {
|
||||||
return (...args) => {
|
return (...args) => {
|
||||||
|
|
||||||
@ -133,6 +162,8 @@ export const wrap = function(pluginObj:any, methodName:string, opts:any = {}) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @private
|
||||||
|
*
|
||||||
* Class decorator specifying Plugin metadata. Required for all plugins.
|
* Class decorator specifying Plugin metadata. Required for all plugins.
|
||||||
*
|
*
|
||||||
* @usage
|
* @usage
|
||||||
@ -166,6 +197,8 @@ export function Plugin(config) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @private
|
||||||
|
*
|
||||||
* Wrap a stub function in a call to a Cordova plugin, checking if both Cordova
|
* Wrap a stub function in a call to a Cordova plugin, checking if both Cordova
|
||||||
* and the required plugin are installed.
|
* and the required plugin are installed.
|
||||||
*/
|
*/
|
||||||
@ -182,6 +215,9 @@ export function Cordova(opts:any = {}) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @private
|
||||||
|
*
|
||||||
|
*
|
||||||
* Before calling the original method, ensure Cordova and the plugin are installed.
|
* Before calling the original method, ensure Cordova and the plugin are installed.
|
||||||
*/
|
*/
|
||||||
export function CordovaProperty(target: Function, key: string, descriptor: TypedPropertyDescriptor<any>) {
|
export function CordovaProperty(target: Function, key: string, descriptor: TypedPropertyDescriptor<any>) {
|
||||||
|
Loading…
Reference in New Issue
Block a user