ts-injecty v0.0.22

Dependency Injection Container for Typescript and Javascript 💉

Getting Started

• Features
• Motivation
• Usage

Features 🏋️‍♂️

• 👌 No dependencies
• 🚀 Simple but powerful
• 🎄 Does not requires decorators
• 🏋️‍♂️ Works great with both javascript and typescript
• 🏎️ Auto register dependencies class.
• 🧩 Well typed for your dependencies

New version 🚀

Now we are supporting factories 🏭

// You must extends your custom factories from Factory, and we will inject automatically the resolver in your factory.

export class FactoryImplementation extends Factory {
    public create(type: "Bar" | "Buzz") {
        if (type === "Bar") {
            return this.resolver.resolve(Bar);
        }

        return this.resolver.resolve(Buzz);
    }
}

Container.register([
    register(Bar).build(),
    register(Buzz).build(),
    register(FactoryImplementation).build(),
]);

const resolved = Container.resolve(FactoryImplementation);

expect(resolved.create("Bar")).toBeInstanceOf(Bar);
expect(resolved.create("Buzz")).toBeInstanceOf(Buzz);

Version: 0.0.18 👇

Support the constructor parameters fully typed

// Now in your IDE you can see the withDependencies, this function is automatically generated only when your class has more than one argument.
class Root {
    constructor(public innerA: InnerRoot, public innerB: InnerRootB) {}
}
register(Root).withDependencies(InnerRoot, InnerRootB).build();

---
// If your class has just one parameter you can see this method
class InnerRoot {
    constructor(public inner: InnerDep) {}
}
register(InnerRootB).withDependency(InnerDep).build();

---
// If your class doesn't have any dependency you can't invoke the withDependency.
class NoDeps {}
register(NoDeps).build();

Motivation 🏃‍♀️

Popular solutions like inversify or tsyringe use reflect-metadata that allows to fetch argument types and based on those types and do autowiring. Autowiring is a nice feature but the trade-off is decorators. Disadvantages of other solutions

1. Those solutions work with typescript only. Since they rely on argument types that we don't have in Javascript.
2. I have to update my tsconfig because one package requires it.
3. Let my components know about injections.
4. They do not respect the principles of clean architecture.

Usage 🥁

Register Class with Class dependency

export class A {
    constructor(private b: B) {}

    public sum(x: number, y: number) {
        return this.b.sum(x, y);
    }
}

export class B {
    public sum(x: number, y: number) {
        return x + y;
    }
}

const dependencies = [register(A).withDependency(B).build()];

Container.register(dependencies);

const a = Container.resolve(A);

expect(a.sum(1, 2)).toBe(3);

Register interface with class implementation

export interface Interface {
    doSomething(): string;
}

export class InterfaceImplementation implements Interface {
    doSomething(): string {
        return "HI";
    }
}

export class ClassWithInterfaceDependency {
    constructor(private readonly dependency: Interface) {}
    doSomething(): string {
        return this.dependency.doSomething();
    }
}

Container.register([
    register("Interface").withImplementation(InterfaceImplementation).build(),
    register(ClassWithInterfaceDependency).withDependency("Interface").build(),
]);

const resolved = Container.resolve(ClassWithInterfaceDependency);

expect(resolved.doSomething()).toBe("HI");

Register objects or functions as reference without any manipulation from container

const FooFunction = () => "HI";

Container.register([
    register("Foo").withImplementation(FooFunction).build(),
]);

const resolved = Container.resolve<typeof FooFunction>("Foo");

expect(resolved).toBe(FooFunction);
expect(resolved()).toBe("HI")

NOTE: The difference for withImplementation or withDynamic is that the first one just save the function reference, but the last one is used for hooks or dynamic functions with reactivity or re rendering cases.

Register api

//if you want register interfaces 👇
//register interface with custom string, because typescript doesn't transpile interfaces.
register("Interface").withDynamic(parameter: Function).build();
register("Interface").withImplementation(implementation: Function | Class | object).build();

//if you want register classes 👇
// Singleton registration
register(YourClass).asASingleton().build();

register(YourClass).asASingleton().withDependency(dependency: string | Function | Class).build();

register(YourClass).asASingleton().withImplementation(implementation: Function | Class | object).build();

// Transient registration without dependencies
register(YourClass).build();

//The dependency can be a string because previously we can register interfaces.
register(YourClass).withDependency(dependency: string | Function | Class).build();

register(YourClass).withImplementation(implementation: Function | Class | object).build();