Git Product home page Git Product logo

js-fireplug's Introduction

fireplug

Simple engine for creating plugin-driven applications

Usage

First, instantiate a plugin manager:

var PluginManager = require('fireplug');
var plugins = new PluginManager();

Next, start using plugins:

var pluginA = {
  method1: function(prev, param1, param2, cb) {
    cb(null, someValue);
  },
  method2: function(prev, param1) {
    return somePromise;
  }
};

var pluginB = {
  method2: function(prev, param1) {
    return prev;
  }
};

plugins.use(pluginA);
plugins.use(pluginB);
plugins.use(arrayOfPlugins);

A plugin is an object with methods. The methods each take, as their first parameter, the value (if any) from any previous plugin, additional parameters for the method, and a callback parameter. The plugin method can work synchronous by either:

  • Returning the previous result argument
  • Returning null
  • Returning a regular value
  • Throwing an error

...or asynchronously by:

  • Calling a node-style callback argument
  • Returning a promise

To invoke plugins, you call the method through the plugin manager in one of two ways, through invoke:

plugins
  .invoke('method1', arg1)
  .then(
    function(result) {
      // Handle result
    },
    function(err) {
      // Handle error
    });

...or, if you know a method is defined at least one plugin, you can use the method name directly:

plugins
  .method1(arg1)
  .then(
    function(result) {
      // Handle result
    },
    function(err) {
      // Handle error
    });

In either case, the plugins are invoked asynchronously so that the plugin author always have an asynchronous option. fireplug uses Promises/A+.

The suggested strategy for structuring a plugin-based application is to integrate a built-in set of plugins, then enable a consumer of your application to inject additional plugins.

js-fireplug's People

Contributors

apoco avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.