- Notifications
You must be signed in to change notification settings - Fork10
A basic logger middleware for InversifyJS
License
inversify/inversify-logger-middleware
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A console logger middleware forInversifyJS.
You can installinversify-logger-middleware using npm:
npm install inversify inversify-logger-middleware reflect-metadata --save
Theinversify-logger-middleware type definitions are included in the npm module and require TypeScript 2.0.Please refer to theInversifyJS documentation to learn more about the installation process.
Lets imagine that we have already configured an InversifyJS Container and the logger middleware using the fillowing bindings:
letmodule=newContainerModule((bind:inversify.interfaces.Bind)=>{bind<Weapon>("Weapon").to(Katana).whenInjectedInto(Samurai);bind<Weapon>("Weapon").to(Shuriken).whenInjectedInto(Ninja);bind<Warrior>("Warrior").to(Samurai).whenTargetTagged("canSneak",false);bind<Warrior>("Warrior").to(Ninja).whenTargetTagged("canSneak",true);});
This middleware will display the InversifyJS resolution plan in console in the following format.
// container.getTagged<Warrior>("Warrior", "canSneak", true);SUCCESS:0.41ms.└── Request :0└── serviceIdentifier :Warrior└──bindings└──Binding<Warrior> :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<Weapon> :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.
You can create a logger using the default settings as follows:
import{makeLoggerMiddleware}from'inversify-logger-middleware';letlogger=makeLoggerMiddleware();
The default options are the following:
letdeatultOptions: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:
functionconsoleRenderer(out:string){console.log(out);}
The following code snippet uses custom settings and a string renderer instead of the default console renderer.
letoptions:LoggerSettings={request:{serviceIdentifier:true,bindings:{scope:true},result:true}};// Takes object (loggerOutput) instead of primitive (string) to share referenceletmakeStringRenderer=function(loggerOutput:{content:string}){returnfunction(out:string){loggerOutput.content=out;};};letloggerOutput={content :""};letstringRenderer=makeStringRenderer(loggerOutput);letlogger=makeLoggerMiddleware(null,stringRenderer);
You can apply the logger middlerare using the InversifyJS API:
letcontainer=newContainer();letlogger=makeLoggerMiddleware();container.applyMiddleware(logger);
Please refere to theInversifyJS documentationto learn more about middleware.
A sample application can be found at theinversify-code-samples repository.
About
A basic logger middleware for InversifyJS
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors6
Uh oh!
There was an error while loading.Please reload this page.