ts-ioc-container 25.0.2 → 25.0.4

package/README.md

@@ -2,10 +2,12 @@
 
 ![NPM version:latest](https://img.shields.io/npm/v/ts-ioc-container/latest.svg?style=flat-square)
 ![npm downloads](https://img.shields.io/npm/dt/ts-ioc-container.svg?style=flat-square)
-![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/ts-ioc-container)
+![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/ts-ioc-container)
 [![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`
@@ -17,7 +19,34 @@
 - composable and open to extend
 - awesome for testing (auto mocking)
 
-## Install
+* * *
+
+- [Setup](#setup)
+- [Container](#container)
+    - [Basic usage](#basic-usage)
+    - [Scopes](#scopes)
+    - [Instances](#instances)
+    - [Disposing](#disposing)
+- [Injectors](#injectors)
+    - [Reflection injector](#reflection-injector)
+    - [Simple injector](#simple-injector)
+    - [Proxy injector](#proxy-injector)
+- [Providers](#providers)
+    - [Provider](#provider)
+    - [Singleton provider](#singleton-provider)
+    - [Tagged provider](#tagged-provider)
+    - [Args provider](#args-provider)
+- [Container modules](#container-modules)
+    - [Basic usage](#basic-usage-1)
+    - [Registration module (Provider + DependencyKey)](#registration-module-provider--dependencykey)
+- [Hooks](#hooks)
+- [Tests and Mocks](#tests-and-mocks)
+- [Errors](#errors)
+
+* * *
+
+## Setup
+
 ```shell script
 npm install ts-ioc-container reflect-metadata
 ```
@@ -25,14 +54,12 @@ npm install ts-ioc-container reflect-metadata
 yarn add ts-ioc-container reflect-metadata
 ```
 
-## Setup
-### reflect-metadata
-Just put it in the main file of your project. It should be the first line of the code.
+Just put it in the entrypoint file of your project. It should be the first line of the code.
 ```typescript
 import 'reflect-metadata';
 ```
 
-### tsconfig.json
+And `tsconfig.json` should have next options:
 ```json
 {
   "compilerOptions": {
@@ -42,8 +69,10 @@ import 'reflect-metadata';
 }
 ```
 
-## Container `IContainer`
-It consists of 2 main parts:
+* * *
+
+## Container
+`IContainer` consists of 2 main parts:
 
 - Providers - describes how to create instances of dependencies
 - Injector - describes how to inject dependencies to constructor
@@ -165,8 +194,10 @@ describe('Disposing', function () {
 
 ```
 
-## Injectors `IInjector`
-Injectors are used to describe how dependencies should be injected to constructor.
+* * *
+
+## Injectors
+`IInjector` is used to describe how dependencies should be injected to constructor.
 
 - `ReflectionInjector` - injects dependencies using `@inject` decorator
 - `ProxyInjector` - injects dependencies as dictionary `Record<string, unknown>`
@@ -299,8 +330,10 @@ describe('ProxyInjector', function () {
 
 ```
 
-## Providers `IProvider<T>`
-Providers are used to describe how instances should be created. It has next basic methods:
+* * *
+
+## Providers
+`IProvider<T>` is used to describe how instances should be created. It has next basic methods:
 - `resolve` - creates instance with passed arguments
 - `clone` - we invoke it when we create a scope. It clones provider to new scope.
 - `isValid` - checks if provider can be resolved from container or cloned to container with certain tags
@@ -457,9 +490,13 @@ describe('ArgsProvider', function () {
 
 ```
 
+* * *
+
 ## Container modules
 Sometimes you want to encapsulate registration logic in separate module. This is what `IContainerModule` is for.
 
+### Basic usage
+
 ```typescript
 import 'reflect-metadata';
 import { IContainerModule, Registration, IContainer, key, Container, ReflectionInjector } from 'ts-ioc-container';
@@ -502,7 +539,7 @@ describe('Container Modules', function () {
 
 ```
 
-## Registration module (Provider + DependencyKey)
+### Registration module (Provider + DependencyKey)
 Sometimes you need to keep dependency key with class together. For example, you want to register class with key 'ILogger' and you want to keep this key with class. This is what `Registration` is for.
 
 ```typescript
@@ -523,6 +560,8 @@ describe('Registration module', function () {
 
 ```
 
+* * *
+
 ## Hooks
 Sometimes you need to invoke methods after construct or dispose of class. This is what hooks are for.
 
@@ -624,7 +663,9 @@ describe('Hooks', function () {
 
 ```
 
-## Mocking / Tests `AutoMockedContainer`
+* * *
+
+## Tests and Mocks
 Sometimes you need to automatically mock all dependencies in container. This is what `AutoMockedContainer` is for.
 
 ```typescript
@@ -666,6 +707,7 @@ describe('Mocking', () => {
 
 ```
 
+* * *
 
 ## Errors
 

package/package.json

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