Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inversify/inversify-logger-middleware
A basic logger middleware for InversifyJS
https://github.com/inversify/inversify-logger-middleware
dependency-injection express inversifyjs inversifyjs-devtools inversifyjs-middleware logger-middleware logging nodejs
Last synced: about 1 month ago
JSON representation
A basic logger middleware for InversifyJS
- Host: GitHub
- URL: https://github.com/inversify/inversify-logger-middleware
- Owner: inversify
- License: mit
- Created: 2016-05-10T21:07:24.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-14T11:05:19.000Z (over 2 years ago)
- Last Synced: 2024-04-14T15:16:59.032Z (3 months ago)
- Topics: dependency-injection, express, inversifyjs, inversifyjs-devtools, inversifyjs-middleware, logger-middleware, logging, nodejs
- Language: TypeScript
- Homepage:
- Size: 279 KB
- Stars: 25
- Watchers: 12
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome - inversify/inversify-logger-middleware - A basic logger middleware for InversifyJS (TypeScript)
README
# inversify-logger-middleware
[](https://gitter.im/inversify/InversifyJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/inversify/inversify-logger-middleware)
[](https://codeclimate.com/github/inversify/inversify-logger-middleware/coverage)
[](http://badge.fury.io/js/inversify-logger-middleware)
[](https://david-dm.org/inversify/inversify-logger-middleware#info=dependencies)
[](https://david-dm.org/inversify/inversify-logger-middleware/#info=devDependencies)
[](https://david-dm.org/inversify/inversify-logger-middleware/#info=peerDependenciess)
[](https://snyk.io/test/github/inversify/inversify-logger-middleware)
[](https://nodei.co/npm/inversify-logger-middleware/)
[](https://nodei.co/npm/inversify-logger-middleware/)
A console logger middleware for [InversifyJS](https://github.com/inversify/InversifyJS).
## Installation
You can install `inversify-logger-middleware` using npm:
```sh
npm install inversify inversify-logger-middleware reflect-metadata --save
```
The `inversify-logger-middleware` type definitions are included in the npm module and require TypeScript 2.0.
Please refer to the [InversifyJS documentation](https://github.com/inversify/InversifyJS#installation) to learn more about the installation process.
### Motivation
Lets imagine that we have already configured an InversifyJS Container and the logger middleware using the fillowing bindings:
```ts
let module = new ContainerModule((bind: inversify.interfaces.Bind) => {
bind("Weapon").to(Katana).whenInjectedInto(Samurai);
bind("Weapon").to(Shuriken).whenInjectedInto(Ninja);
bind("Warrior").to(Samurai).whenTargetTagged("canSneak", false);
bind("Warrior").to(Ninja).whenTargetTagged("canSneak", true);
});
```
This middleware will display the InversifyJS resolution plan in console in the following format.
```ts
// container.getTagged("Warrior", "canSneak", true);
SUCCESS: 0.41 ms.
└── Request : 0
└── serviceIdentifier : Warrior
└── bindings
└── Binding : 0
└── type : Instance
└── implementationType : Ninja
└── scope : Transient
└── target
└── serviceIdentifier : Warrior
└── name : undefined
└── metadata
└── Metadata : 0
└── key : canSneak
└── value : true
└── childRequests
└── Request : 0
└── serviceIdentifier : Weapon
└── bindings
└── Binding : 0
└── type : Instance
└── implementationType : Shuriken
└── scope : Transient
└── target
└── serviceIdentifier : Weapon
└── name : shuriken
└── metadata
└── Metadata : 0
└── key : name
└── value : shuriken
└── Metadata : 1
└── key : inject
└── value : Weapon
```
You can configure which elements of the resolution plan are being displayed.
This kind of information can help you during the development of applications with InersifyJS.
### Default settings and renderer
You can create a logger using the default settings as follows:
```ts
import { makeLoggerMiddleware } from 'inversify-logger-middleware';
let logger = makeLoggerMiddleware();
```
The default options are the following:
```ts
let deatultOptions: LoggerSettings = {
request: {
bindings: {
activated: false,
cache: false,
constraint: false,
dynamicValue: false,
factory: false,
implementationType: true,
onActivation: false,
provider: false,
scope: false,
serviceIdentifier: false,
type: false
},
serviceIdentifier: true,
target: {
metadata: true,
name: false,
serviceIdentifier: false
}
},
time: true
};
```
You can use the option to determine which elements of the resolution plan should be logged.
The default renderer look as follows:
```ts
function consoleRenderer(out: string) {
console.log(out);
}
```
### Custom settings and renderer
The following code snippet uses custom settings and a string renderer instead of the default console renderer.
```ts
let options: LoggerSettings = {
request: {
serviceIdentifier: true,
bindings: {
scope: true
},
result: true
}
};
// Takes object (loggerOutput) instead of primitive (string) to share reference
let makeStringRenderer = function (loggerOutput: { content: string }) {
return function (out: string) {
loggerOutput.content = out;
};
};
let loggerOutput = { content : "" };
let stringRenderer = makeStringRenderer(loggerOutput);
let logger = makeLoggerMiddleware(null, stringRenderer);
```
### Applying the middleware
You can apply the logger middlerare using the InversifyJS API:
```ts
let container = new Container();
let logger = makeLoggerMiddleware();
container.applyMiddleware(logger);
```
Please refere to the
[InversifyJS documentation](https://github.com/inversify/InversifyJS#middleware)
to learn more about middleware.
### Demo app
A sample application can be found at the
[inversify-code-samples](https://github.com/inversify/inversify-code-samples/tree/master/inversify-binding-decorators) repository.