Ghost/core/server/plugins/GhostPlugin.js

51 lines
1.1 KiB
JavaScript
Raw Normal View History

var GhostPlugin;
/**
* GhostPlugin is the base class for a standard plugin.
* @class
* @parameter {Ghost} The current Ghost app instance
*/
GhostPlugin = function (ghost) {
this.app = ghost;
};
/**
* A method that will be called on installation.
* Can optionally return a promise if async.
* @parameter {Ghost} The current Ghost app instance
*/
GhostPlugin.prototype.install = function (ghost) {
return;
};
/**
* A method that will be called on uninstallation.
* Can optionally return a promise if async.
* @parameter {Ghost} The current Ghost app instance
*/
GhostPlugin.prototype.uninstall = function (ghost) {
return;
};
/**
* A method that will be called when the plugin is enabled.
* Can optionally return a promise if async.
* @parameter {Ghost} The current Ghost app instance
*/
GhostPlugin.prototype.activate = function (ghost) {
return;
};
/**
* A method that will be called when the plugin is disabled.
* Can optionally return a promise if async.
* @parameter {Ghost} The current Ghost app instance
*/
GhostPlugin.prototype.deactivate = function (ghost) {
return;
};
module.exports = GhostPlugin;