warm
This node.js module is useful if you want to load other modules and be sure all warming code is executed before you continue.
Quick usage
Install module into own project
# npm install --save warm
Create new class and call .parallel
method
Warm = ; './database' './redis';
Modules database
and redis
should return special method (.init
by default), which resolve promise or call callback on finish. See Modules
Options
You can pass additional options like plain object: new Warm({ ... }, 'module1', ...)
:
Name | Default | Description |
---|---|---|
.expect |
promise |
will init method inform about finish with promise (reject/resolve it), or will fire callback with error (expect: 'callback' ) |
.path |
'' |
prefix for requiring modules |
.strict |
true |
should return error if init method not found in module |
.init |
init |
init method name |
Samples
Warm = ; // load modules in array or additional parameters with optionsoptions1 = expect: 'callback'options2 = strict: trueoptions1 './module1' './module2' './module3' options2; // execute already loaded module; // handle promise'./module1'
Modules
Module should contain method .init
(or other, described in options) which will return promise or file callback. Example:
module { return 'i will not fire';};moduleexports { ;};
Additional samples can be found in test folder