https://github.com/denrox/node-service-container
Service container for nodejs apps. Supports lazy loading, inheriting from other sevice through config, wrapping native node modules with service container.
https://github.com/denrox/node-service-container
Last synced: about 24 hours ago
JSON representation
Service container for nodejs apps. Supports lazy loading, inheriting from other sevice through config, wrapping native node modules with service container.
- Host: GitHub
- URL: https://github.com/denrox/node-service-container
- Owner: Denrox
- License: mit
- Created: 2017-12-04T08:35:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-04T12:08:40.000Z (over 8 years ago)
- Last Synced: 2026-05-19T10:47:21.298Z (about 1 month ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
## Installation
```bash
$ npm i node-sc
```
## Features
* Service container for node, builds service with their dependencies
* Allows to wrap native and installed node modules into container
* Allows to use config file with declaratively specified dependencies
* Allows to specify custom constructor functions for services
## Examples
Here is a simple usage example:
```bash
$ npm i node-sc
```
Configuration file structure for services container can look like this:
```javascript
{
"fs": {
//for modules located in node_modules path should be just a module name
"location": "fs",
//states that service will be a wrapped native module
"isPackage": true
},
"path": {
"location": "path",
"isPackage": true
},
"errorFormatter": {
//for custom services path shuld be relative
"location": "./services/ErrorFormatter",
//this states that our service should be instantiated via "new", or via custom constructor
"construct": true,
//our service will be a singleton, so we specify a custom constructor function for it
"constructFn": "getInstance"
},
"fileLogger": {
"location": "./services/FileLogger",
"construct": true,
//these are dependencies for our service, they are specified as aliases for other services
"dependencies": [
"fs",
"path",
"errorFormatter"
]
}
}
```
Usage of the service container is following:
```javascript
const ServiceContainer = require('node-sc');
//base dir relative to which paths to services will be specified in config
let baseDir = __dirname;
let sc = ServiceContainer.getInstance(baseDir, {
"fs": {
//for modules located in node_modules path should be just a module name
"location": "fs",
//states that service will be a wrapped native module
"isPackage": true
},
"path": {
"location": "path",
"isPackage": true
},
"errorFormatter": {
//for custom services path shuld be relative
"location": "./services/ErrorFormatter",
//this states that our service should be instantiated via "new", or via custom constructor
"construct": true,
//our service will be a singleton, so we specify a custom constructor function for it
"constructFn": "getInstance"
},
"fileLogger": {
"location": "./services/FileLogger",
"construct": true,
//these are dependencies for our service, they are specified as aliases for other services
"dependencies": [
"fs",
"path",
"errorFormatter"
]
}
});
sc.getService('fileLogger').logError('This is an example error text');
```
## License
[MIT](LICENSE)