UNPKG

node-pluginsmanager

Version:

A plugins manager

github.com/Psychopoulet/node-pluginsmanager

Psychopoulet/node-pluginsmanager

80 lines (53 loc) • 3.8 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# node-pluginsmanager A plugins manager [![Build status](https://api.travis-ci.org/Psychopoulet/node-pluginsmanager.svg?branch=master)](https://travis-ci.org/Psychopoulet/node-pluginsmanager) [![Coverage status](https://coveralls.io/repos/github/Psychopoulet/node-pluginsmanager/badge.svg?branch=master)](https://coveralls.io/github/Psychopoulet/node-pluginsmanager) [![Dependency status](https://david-dm.org/Psychopoulet/node-pluginsmanager/status.svg)](https://david-dm.org/Psychopoulet/node-pluginsmanager) [![Dev dependency status](https://david-dm.org/Psychopoulet/node-pluginsmanager/dev-status.svg)](https://david-dm.org/Psychopoulet/node-pluginsmanager?type=dev) [![Issues](https://img.shields.io/github/issues/Psychopoulet/node-pluginsmanager.svg)](https://github.com/Psychopoulet/node-pluginsmanager/issues) [![Pull requests](https://img.shields.io/github/issues-pr/Psychopoulet/node-pluginsmanager.svg)](https://github.com/Psychopoulet/node-pluginsmanager/pulls) > please note that this version is only usable with node-pluginsmanager-plugin 3.x.x && 4.x.x ## Installation ```bash $ npm install node-pluginsmanager ``` ## Features * simply manage plugins (extended from [node-pluginsmanager-plugin](https://github.com/Psychopoulet/node-pluginsmanager-plugin)) to interact with specifics hardwares / API / whatever * install plugins manually or via github & initialize them * update plugins via github * uninstall plugins and release there resources * run plugins' middlewares for server, to create specifics rules * check plugins' modules' versions ## Architecture ### Plugin ![Plugin](https://raw.githubusercontent.com/Psychopoulet/node-pluginsmanager-plugin/master/documentation/pictures/functional.jpg) ### Routes ![Routes](./documentation/routes.jpg) ## Content [check the TypeScript definition file](https://github.com/Psychopoulet/node-pluginsmanager/blob/master/lib/index.d.ts) ## Events * ``` on("error", (err: Error) => void) : this ``` fires if an error occurs * ``` on("loading", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin starts load * ``` on("loaded", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin ends load * ``` on("allloaded", (data?: any) => void) : this ``` fires if all the plugins are loaded * ``` on("initializing", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin starts init * ``` on("initialized", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin ends init * ``` on("allinitialized", (data?: any) => void) : this ``` fires if all the plugins are initialized * ``` on("released", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin is released * ``` on("allreleased", (data?: any) => void) : this ``` fires if all the plugins are released * ``` on("destroyed", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is destroyed * ``` on("alldestroyed", (data?: any) => void) : this ``` fires if all the plugins are destroyed * ``` on("installed", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is installed * ``` on("updated", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin is updated * ``` on("uninstalled", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is uninstalled ## Examples [check the TypeScript compilation tests](https://github.com/Psychopoulet/node-pluginsmanager/blob/master/test/typescript/compilation.ts) ## Tests ```bash $ git clone git://github.com/Psychopoulet/node-pluginsmanager.git $ cd ./node-pluginsmanager $ npm install $ npm run-script tests ``` ## License [ISC](LICENSE)