gitci-baseaction
v1.0.0
Published
Base action the be used when creating you own action to GitCI
Downloads
5
Readme
GitCI-BaseAction
Base action the be used when creating you own action to GitCI
Description
This base action should be used when creating a new Action for GitCI.
Know more about GitCI visiting:
GitHub: https://github.com/jmtvms/GitCI
NPM: https://www.npmjs.com/package/gitci
Status
| Branch | Build status | |----------|:------------:| | master | | | develop | |
Example
This is the example of the implementation of your own action.
const util = require("util");
const baseAction = require("gitci-baseaction");
var MyCommand = function(action){
// Call the constructor from the base action.
MyCommand.super_.call(this, action);
// Add the events you want do allow the implementation to have.
this.availableListeners.push("myEvent");
// Add more custom code here.
...
}
util.inherits(MyCommand, baseAction.BaseAction);
// Override this function with your execute.
MyCommand.prototype.execute = function () {
...
MyCommand.emit("actionSuccess", Object);
};
// Override this function with your validation of the command.
// Must return a boolean indicating that its valid or not.
MyCommand.prototype.validade = function () {
...
};