@aster-js/ioc NPM

@aster-js/ioc

Documentation in progress

This project provides a standalone dependency injection / inversion of control library.

A more SPA service architecture / ecosystem is built through @aster-js/app.

It's compatible with any renderer and enable to structure your code using SOA architecture offering then decoupling, abstration, easy to unit test and modulary to your project.

Let see how difficult it is...

Create your first services

First of all, its recommanded to declare explicitly the service id and implementation:

Step 1: Declaring the service identifier and its contract:

Making use of declaration merge we can declare the Service Identifier and the interface using the same name to simplify futher declarations.

export const IHttpService = ServiceIdentifier<IHttpService>("IHttpService");

export interface IHttpService {
    get(url: string): Promise<string>;
}

Step 2: Create your first implementation

Once you have declared the service id, you are now able to start implement this service:

@ServiceContract(IHttpService)
export class HttpService implements IHttpService {
    async get(url: string): Promise<string> {
        const res = await fetch(url);
        return await res.text()
    }
}

The ServiceContract decorator is optional, but it will be usefull later to reduce the binding declaration enabling auto discovery of the link between the implementation and its service id.

Explicit implements declaration can be removed when using the @ServiceContract decorator that already validate by itself the decorated class implements properly the service id interface.

Step 3: Create your a service without service id

As its not mandatory, only recommanded, no service id is necessary to register something in the IoC.

@ServiceContract will be then unexpected.

This time we will also consume the IHttpService.

export class CustomerService {

    addresses: Address[];

    constructor(
        @IHttpService private readonly _httpService: IHttpService
    ){}

    async loadAdresses(): Promise<void> {
        this.addresses = await this._httpService.get(`/api/customers/addresses`);
    }
}

Create an IoCContainer

Once you have all your services declared, you can now create your service container:

const kernel = IoCKernel.create()
    .configure(services => {
        services
            .addSingleton(CustomerService)
            .addSingleton(HttpService);
    })
    // If a service id is attached, use the service id instead
    // The actual sample demonstrate `CustomerService` as declared without id
    .setup(CustomerService, async svc => await svc.loadAdresses())
    .build();

kernel.start();

And obviously, getting an address of a customer like that is a bit overkill.

Injection methods

Basic: Use the service identifier

Every service identifier is also a decorator that enable constructor parameter injection.

constructor(@IHttpService httpService: IHttpService) { }

Anonymous: When you didn't declare explicit service id

@Inject decorator will find the service id associated to your class.

constructor(@Inject(CustomerService) customerService: CustomerService) { }

Optional: Service may not be registered

You can try to reference a service even tho it may not be registered.

constructor(@Optional(IHttpService) httpService: IHttpService | undefined) { }

Many: Inject all accessible instances

Requires a service identfier and as many service registration you need... 0 will inject an empty and 3 will inject the 3 instances.

constructor(@Many(IHandler) handlers: IHandler[]) { }

Options: Merge all accessible instances into 1

Requires a service identfier that will describe options required by other services. This pattern will allow user of your services to customize options related to their usage. At the end, the service that consume options will get a single instance where all individual instances are merge into.

export const HttpOptions = ServiceIdentifier<HttpOptions>("HttpOptions");

export type HttpOptions = {
    readonly baseAddress: string;
    readonly defaultHeaders: Record<string, string>;
}

export HttpClient {
    constructor(@Options(HttpOptions) private readonly _options: HttpOptions) { }

// Default options can be injected through a default function
// provided by the lib with other required services
function addHttpClient(builder: IIoCModuleBuilder) {
    return builder.configure(services =>{
        services.addInstance(HttpOptions, {
            baseAddress: location.origin + "/api",
            defaultHeaders:{},
            authenticate: false,
            useProxy: false
        });
    });
}

// Using the lib, you can should which property to override
addHttpClient(builder)
    .configure(services =>{
        services.addInstance(HttpOptions, {
            baseAddress: "https://myapi.myorg.org",
            authenticate: true
        });
    });

@aster-js/ioc v1.7.0