https://github.com/ribeiro-rodrigo/safira
Container IOC for Node.js applications
https://github.com/ribeiro-rodrigo/safira
dependency-injection ecmascript6 nodejs object-oriented-programming
Last synced: 7 months ago
JSON representation
Container IOC for Node.js applications
- Host: GitHub
- URL: https://github.com/ribeiro-rodrigo/safira
- Owner: ribeiro-rodrigo
- Created: 2017-05-07T12:21:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T15:03:52.000Z (over 2 years ago)
- Last Synced: 2024-08-08T20:56:11.834Z (11 months ago)
- Topics: dependency-injection, ecmascript6, nodejs, object-oriented-programming
- Language: JavaScript
- Size: 149 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Safira
A library for NodeJS projects that makes it possible to inject dependencies into Javascript classes written in ES6.
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build Status][build-status]][build-url]
[![Coverage][codecov-image]][codecov-url]
# Installation
```
npm install safira --save
```
# Defining classes
```javascript
const safira = require('safira');
class Employee{
constructor(company){
this._company = company
}
get company(){
return this._company;
}
}
safira.define(Employee);
class Company{
constructor(){
}
get name(){
return 'Company Name'
}
}
safira.define(Company);
```
# Defining objects
```javascript
const safira = require('safira');
let company = {name:"My Company"};
safira.defineObject(company,'company');
```
# Getting beans
By default the bean will be available through the class name with the first lowercase letter.
```javascript
const safira = require('safira');
let employee = safira.bean('employee');
console.log(employee.company.name); //Company Name
```
By default all beans built by Safira are singleton, so to change that share, specify the singleton (false) option in the class definition.
```javascript
safira.define(Employee)
.singleton(false);
```
```javascript
const safira = require('safira');
const employee1 = safira.bean('employee');
const employee2 = safira.bean('employee');
console.log(employee1 === employee2); //false
```
# Getting class
Safira allows you to get the class of a bean already declared
```javascript
class Animal{
constructor(){}
get name(){
return "Safira";
}
}
safira.define(Animal);
class Cat extends safira.class('animal'){
constructor(){
super();
}
}
safira.define(Cat);
let cat = safira.bean('cat');
console.log(cat.name === 'Safira');
```
# Loading classes
By default, safira will create the beans only when needed, ie when a call to safira.bean('beanName') is performed. To change this behavior and create the bean at the time of its setting do as described below.
```javascript
const safira = require('safira');
class Person{
constructor(){
this._name = 'my name';
}
}
safira.define(Person)
.build()
.eager();
```
It is also possible to define a callback method that is invoked when the class is loaded by the safira container. By default, safira will invoke the created method if it is set, but if it is necessary to define another method as callback, the postConstruct option can be used.
```javascript
class Person{
constructor(){
this._name = 'my name';
}
created(){
console.log('bean created');
}
}
class Animal{
constructor(){
this._name = 'animal name';
}
callbackMethod(){
console.log('bean created');
}
}
safira.define(Person)
.build()
.eager();
safira.define(Animal)
.postConstruct('callbackMethod')
.build()
.eager()
```
# Customizing Bean Name
```javascript
const safira = require('safira');
class Company{
constructor(){
}
get name(){
return 'Company Name';
}
}
safira.define(Company,'enterprise');
let company = safira.bean('enterprise');
console.log(company.name) //Company Name
```
# Customizing Dependency Injection
Safira allows you to inject dependencies through the class constructor and properties. The beans injected by the constructor that have the same name as the class with the first lowercase letter are automatically injected, but the bean name can be customized and other values can also be injected.
```javascript
const safira = require('safira');
class Company{
constructor(){
}
get name(){
return 'Company Name'
}
}
safira.define(Company);
class Employee{
constructor(employeeCompany,age,firstName){
this._employeeCompany = employeeCompany
this._age = age;
this._firstName = firstName;
}
get employeeCompany(){
return this._employeeCompany;
}
get age(){
return this._age;
}
get firstName(){
return this._firstName;
}
}
safira.define(Employee)
.constructorArg({ref:"company",name:"employeeCompany"})
.constructorArg({value:28,name:"age"})
.constructorArg({value:"Michael",name:"firstName"})
```
It is also possible to inject dependencies and values directly into the properties of the class.
```javascript
const safira = require('safira');
class Company{
constructor(){
}
get name(){
return 'Company Name'
}
}
safira.define(Company);
class Employee{
constructor(){}
get employeeCompany(){
return this._employeeCompany;
}
get age(){
return this._age;
}
get firstName(){
return this._firstName;
}
}
safira.define(Employee)
.inject({ref:"company",name:"_employeeCompany"})
.inject({value:28,name:"_age"})
.inject({value:"Michael",name:"_firstName"});
```
If the ref value is equal to the class property name, the name property can be omitted.
```javascript
const safira = require('safira');
class Company{
constructor(){
}
get name(){
return 'Company Name'
}
}
safira.define(Company);
class Employee{
constructor(){}
get company(){
return this._company;
}
set company(company){
this._company = company;
}
}
safira.define(Employee)
.inject({ref:"company"});
```
# Learn more
See a complete example project [here](https://github.com/ribeiro-rodrigo/planet-service)
[npm-image]: https://img.shields.io/npm/v/safira.svg
[npm-url]: https://npmjs.org/package/safira
[downloads-image]: https://img.shields.io/npm/dm/safira.svg
[downloads-url]: https://npmcharts.com/compare/safira?minimal=true
[build-status]: https://travis-ci.org/ribeiro-rodrigo/safira.svg?branch=master
[build-url]: https://travis-ci.org/ribeiro-rodrigo/safira
[codecov-image]: https://codecov.io/gh/ribeiro-rodrigo/safira/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/ribeiro-rodrigo/safira