ts-ioc-container 25.0.4 → 25.0.6

package/README.md

@@ -6,8 +6,6 @@
 [![Coverage Status](https://coveralls.io/repos/github/IgorBabkin/ts-ioc-container/badge.svg?branch=master)](https://coveralls.io/github/IgorBabkin/ts-ioc-container?branch=master)
 ![License](https://img.shields.io/npm/l/ts-ioc-container)
 
-* * *
-
 ## Advantages
 - battle tested :boom:
 - written on `typescript`
@@ -19,7 +17,7 @@
 - composable and open to extend
 - awesome for testing (auto mocking)
 
-* * *
+## Content
 
 - [Setup](#setup)
 - [Container](#container)
@@ -40,11 +38,11 @@
     - [Basic usage](#basic-usage-1)
     - [Registration module (Provider + DependencyKey)](#registration-module-provider--dependencykey)
 - [Hooks](#hooks)
+    - [OnConstruct](#onconstruct)
+    - [OnDispose](#ondispose)
 - [Tests and Mocks](#tests-and-mocks)
 - [Errors](#errors)
 
-* * *
-
 ## Setup
 
 ```shell script
@@ -69,8 +67,6 @@ And `tsconfig.json` should have next options:
 }
 ```
 
-* * *
-
 ## Container
 `IContainer` consists of 2 main parts:
 
@@ -194,8 +190,6 @@ describe('Disposing', function () {
 
 ```
 
-* * *
-
 ## Injectors
 `IInjector` is used to describe how dependencies should be injected to constructor.
 
@@ -330,8 +324,6 @@ describe('ProxyInjector', function () {
 
 ```
 
-* * *
-
 ## Providers
 `IProvider<T>` is used to describe how instances should be created. It has next basic methods:
 - `resolve` - creates instance with passed arguments
@@ -490,8 +482,6 @@ describe('ArgsProvider', function () {
 
 ```
 
-* * *
-
 ## Container modules
 Sometimes you want to encapsulate registration logic in separate module. This is what `IContainerModule` is for.
 
@@ -560,16 +550,13 @@ describe('Registration module', function () {
 
 ```
 
-* * *
-
 ## Hooks
 Sometimes you need to invoke methods after construct or dispose of class. This is what hooks are for.
 
+### OnConstruct
 ```typescript
 import 'reflect-metadata';
 import {
-  singleton,
-  by,
   constructor,
   Container,
   key,
@@ -577,11 +564,10 @@ import {
   hook,
   IContainer,
   IInjector,
-  inject,
-  provider,
   ReflectionInjector,
   Registration,
 } from 'ts-ioc-container';
+import * as console from 'console';
 
 class MyInjector implements IInjector {
   private injector = new ReflectionInjector();
@@ -597,6 +583,48 @@ class MyInjector implements IInjector {
   }
 }
 
+@key('logger')
+class Logger {
+  isReady = false;
+
+  @hook('onConstruct')
+  initialize() {
+    this.isReady = true;
+  }
+
+  log(message: string): void {
+    console.log(message);
+  }
+}
+
+describe('onConstruct', function () {
+  it('should make logger be ready on resolve', function () {
+    const container = new Container(new MyInjector()).use(Registration.fromClass(Logger));
+
+    const logger = container.resolve<Logger>('logger');
+
+    expect(logger.isReady).toBe(true);
+  });
+});
+
+```
+
+### OnDispose
+```typescript
+import 'reflect-metadata';
+import {
+  singleton,
+  by,
+  Container,
+  key,
+  getHooks,
+  hook,
+  inject,
+  provider,
+  Registration,
+  ReflectionInjector,
+} from 'ts-ioc-container';
+
 @key('logsRepo')
 @provider(singleton())
 class LogsRepo {
@@ -609,16 +637,10 @@ class LogsRepo {
 
 @key('logger')
 class Logger {
-  isReady = false;
   private messages: string[] = [];
 
   constructor(@inject(by('logsRepo')) private logsRepo: LogsRepo) {}
 
-  @hook('onConstruct')
-  initialize() {
-    this.isReady = true;
-  }
-
   log(message: string): void {
     this.messages.push(message);
   }
@@ -630,13 +652,11 @@ class Logger {
   }
 }
 
-describe('Hooks', function () {
-  function createContainer() {
-    return new Container(new MyInjector());
-  }
-
+describe('onDispose', function () {
   it('should invoke hooks on all instances', async function () {
-    const container = createContainer().use(Registration.fromClass(Logger)).use(Registration.fromClass(LogsRepo));
+    const container = new Container(new ReflectionInjector())
+      .use(Registration.fromClass(Logger))
+      .use(Registration.fromClass(LogsRepo));
 
     const logger = container.resolve<Logger>('logger');
     logger.log('Hello');
@@ -651,20 +671,10 @@ describe('Hooks', function () {
 
     expect(container.resolve<LogsRepo>('logsRepo').savedLogs).toContain('Hello');
   });
-
-  it('should make logger be ready on resolve', function () {
-    const container = createContainer().use(Registration.fromClass(Logger)).use(Registration.fromClass(LogsRepo));
-
-    const logger = container.resolve<Logger>('logger');
-
-    expect(logger.isReady).toBe(true);
-  });
 });
 
 ```
 
-* * *
-
 ## Tests and Mocks
 Sometimes you need to automatically mock all dependencies in container. This is what `AutoMockedContainer` is for.
 
@@ -707,8 +717,6 @@ describe('Mocking', () => {
 
 ```
 
-* * *
-
 ## Errors
 
 - [DependencyNotFoundError.ts](lib%2Fcontainer%2FDependencyNotFoundError.ts)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-ioc-container",
-  "version": "25.0.4",
+  "version": "25.0.6",
   "description": "Typescript IoC container",
   "publishConfig": {
     "access": "public",
@@ -56,5 +56,5 @@
     "ts-node": "^10.9.1",
     "typescript": "4.4.3"
   },
-  "gitHead": "02c953490e29c0a46b6609ae22ca6b1a688406e6"
+  "gitHead": "ecf176122b8a6a635b0c47e90306bb3c4e2f8015"
 }