@fridgefm/inverter v0.3.0

@fridgefm/inverter

A powerful and tiny IoC library with Typescript-first support. Lets you create highly scalable modular apps and libraries.

Key features

• Powerful TS support
• NestJS-similar API
• Zero-dependency (even reflect-metadata)
• Async auto-resolve providers
• Hierarchical containerss and Injection scopes
• Multi-token support
• Static provider declaration and no inconsistency
• Works in Node and browser

Installation

npm install @fridgefm/inverter --save

or

yarn add @fridgefm/inverter

Basic features

Injection types

There are several methods to provide a value for injectables. First of all, create a token you want to provide

const myToken = createToken<{ a: number }>("my:token");

1. useValue\ The most basic method of providing a value is useValue. Simply provide a value, which is assignable to myTokens's interface.

   const myProvider = injectable({
     provide: myToken,
     useValue: { a: 1 },
   });

2. useFactory\ Sometimes you want to generate a value and save something in the closure.

   const myProvider = injectable({
     provide: myToken,
     useFactory: () => {
       // do something here if you want... It will run while constructing the provider
       const a = Date.now();
       return { a };
     },
   });

   or with depdendencies

   const myProvider = injectable({
     provide: myToken,
     // type is automatically inferred from all the tokens your provider depends on
     useFactory: (num, anotherNum) => num + anotherNum + 10,
     inject: [numberToken, anotherNumberToken] as const,
   });

   useFactory also has a scope field, which you can configure. Refer to Injection scopes for more info

Token modifications

Set of modificators that allow you to modify your tokens.

import { modifyToken, createToken } from "@fridgefm/inverter";

// value will be overwritten with the last registered provider, which provides this token
const baseToken = createToken<number>("num");
// value will be injected as an array and each new provider adds to the array
const multiToken = modifyToken.multi(baseToken);
// if token is not provided, it will return default value
const defaultToken = modifyToken.defaultValue(baseToken, 101);

1. defaultValue

   const myProvider = injectable({
     provide: baseToken,
     useFactory: (num) => num * 10, // if the token is not registered in the container, you still get the default value for `num`
     inject: [defaultToken] as const,
   });
   const finalValue = await container.get(baseToken); // 1010 (a result of 101*10)

2. multi

   const myProvider = injectable({
     provide: baseToken,
     useFactory: (multiNums) => multiNums.reduce((acc, cur) => acc + cur, 0), // here `multiNums` is a an array of numbers
     inject: [multiToken] as const,
   });
   const num1Provider = injectable({ provide: multiToken, useValue: 15 });
   const num2Provider = injectable({ provide: multiToken, useValue: 25 });
   const num3Provider = injectable({ provide: multiToken, useValue: 35 });
   const finalValue = await container.get(baseToken); // 75 (it is a sum of all the multiNums)

Container hierarchy

It is possible to create child containers and develop hierarchies. Child containers are useful when you have some private information (for example for each request) and no other containers (including the parent one) have access to it.

const globalContainer = createContainer({ providers: [] });
const childContainer = createContainer(
  {
    providers: [injectable({ provide: PRIVATE_TOKEN, useValue: token })],
  },
  rootContainer
).get(VALUE_THAT_DEPENDS_ON_PRIVATE_TOKEN);

In a real world such an invocation is sometimes not possible, because it might lead to a cyclic dependencies between modules/files. It happens because we might want to import an inverter module inside the container, and the module needs to reference the container to create a child one. In this case it might lead to errors, where imported modules might end up being undefined. That is why you should a method to create child container:

import { internalTokens } from "./";

injectable({
  provide: SERVER_INIT,
  inject: [internalTokens.SELF_CONTAINER] as const,
  useFactory: (baseContainer) => {
    const server = new Server();

    server.on("connection", (clientInfo) => {
      // it creates a child container, which can shadow some of the deps
      return createContainer(
        {
          providers: [
            injectable({ provide: CLIENT_INFO, useValue: clientInfo }),
          ],
        },
        baseContainer
      ).get(SESSION_ROOT);
    });
  },
});

Warning: this is an experimental feature and the API might change in the future

Injection scopes

Imagine we have created a bunch of containers: 1 parent and 2 childs:

const container = createContainer({ providers });
const childContainers = [
  createContainer({}, container),
  createContainer({}, container),
];
const allContainers = [container, ...childContainers];
const provider = injectable({
  provide: RANDOM,
  useFactory: () => randomString(),
  scope: SCOPE,
});
const resolveAll = () =>
  Promise.all(
    allContainers.map((cont) =>
      Promise.all([cont.get(RANDOM), cont.get(RANDOM)])
    )
  );

Now the result of calling resolveAll depends on the SCOPE variable. There are different variants:

1. singleton\ Caches the value globally for the parent and all the chilren

   const provider = injectable({
     provide: RANDOM,
     useFactory: () => randomString(),
     scope: "singleton",
   });
   await resolveAll();
   //  parent           child-1          child-2
   // [5e546e, 5e546e] [5e546e, 5e546e] [5e546e, 5e546e]

2. scoped\ This is the default\ Caches the result per-container

   const provider = injectable({
     provide: RANDOM,
     useFactory: () => randomString(),
     scope: "scoped",
   });
   await resolveAll();
   //  parent           child-1          child-2
   // [b539d7, b539d7] [02176f, 02176f] [99a3e0, 99a3e0]

3. transient\ Does not cache at all

   const provider = injectable({
     provide: RANDOM,
     useFactory: () => randomString(),
     scope: "transient",
   });
   await resolveAll();
   //  parent           child-1          child-2
   // [e63742, 59defd] [0abb46, 5cd9a1] [690125, 227e8c]