Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build StatusCoverage StatusDoc Statusnpm versionNode versionDependencie StatusDev Dependencie Statusnpm

Feature

This module allows to initialize modules during runtime. It is designed to allow a modular system in node js.

ModuleManager

Create a new Manager with

import ModuleManager from 'modulemanager';

const moduleManager = new ModuleManager(options);

Variables

Place the variables in a JSON Object (or call without to use defaults)

optional variable default description
yes folder ./modules folderpath relative to current file as string
yes moduleList List of modules by name or name and path to load
yes passCaller true pass the modulemanager as this.parent to modules
yes options JSON Object for options to pass to modules

Example

const options = {
	folder: './folder/plugins',
	// loads plugin1 and plugin2 from ./folder/plugins and plugin3 from ../
	moduleList: ['plugin1', 'plugin2', {name: 'plugin3', path: '../plug3'}],
	// the options will be available through this.KEY
	options: {
		app: app, 			// available through this.app
		db: connection,	// available through this.db
		socket: io			// available through this.socket
	}
}

const moduleManager = new ModuleManager(options);

Functions

Install

You can either install a module if it is in a subfolder containing their name or by giving the path.

moduleManager.install('plugin1');

Activate

You can either activate a module if it is in a subfolder containing their name or by giving the path.

moduleManager.activate('plugin1');

Update

You can either update a module if it is in a subfolder containing their name or by giving the path. Warning: their is no check if the installed version is newer, please do this before updating the module.

moduleManager.update('plugin1');

Deactivate

You can deactivate an active module by calling its name. If no such module is active, an error is logged.

moduleManager.deactivate('plugin1');

Uninstall

You can either uninstall a module if it is active by calling the name or if it is in a subfolder containing their name or by giving the path.

moduleManager.uninstall('plugin1');

Modules

Creating Modules

Package.json

Create a package.json containing a main key for the entrypoint.

{
	"main": "./index.js"
}

Extend Module class

Import the Modules class

import { Module } from 'modulemanager';

Create a default class, which extends Module in the entrypoint

export default class Module1 extends Module {
	// functions here
};

Necessary functions

You need to create the functions install, uninstall, activate, deactivate and update (only if it isn't the first version)

Currently the package is built for ES7 async, so async functions are necessary.

async install() {
	// Your code here
}

async uninstall() {
	// Your code here
}

// for all versions newer then first release
async update() {
	// Your code here
}

async activate() {
	// Your code here
}

async deactivate() {
	// Your code here
	}

Variables

you can access the objects with

this.OBJECTKEY

License

ISC License

Copyright (c) 2016, Matthias Feldmann

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Author

Matthias Feldmann

About

A manager for modular plugins in node

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published