Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

sand-grain

1.2.1 • Public • Published

Build Status npm version

Sand Base Grain/Module

All Grains (Modules) used by Sand must first extend this base grain.

To begin

  1. Install it:

    $ npm install sand-grain -S
  2. Create a new module which extends SandGrain and implement SandGrain.name property, SandGrain.init() method and, optionally, SandGrain.shutdown()

    var SandGrain = require('sand-grain');
     
    var MyModule = SandGrain.extend({
        name: 'MyModule', // required
        
        init: function(config, done) { // required
            this.super(config, done);
            // your initialization goes here
        },
        
        shutdown: function(done) { // optional
            // implementing this hook is optional
            // your shutdown logic goes here
            // Make sure to call done when you are done shutting down
        }
        
        // add other public functions that you'd like to export here
    });
  3. Use your shiny new module with Sand

    var sand = require('sand')();
    var MyModule = require('my-sand-module');
     
    sand.use(MyModule).start();
     
    // now that sand is started, you can use sand.MyModule.myFunction() anywhere in your project

License

ISC © 2014 Pocketly

Keywords

install

npm i sand-grain

Downloadsweekly downloads

11

version

1.2.1

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
Report a vulnerability