Setting services (Injectables)

Last updated 14 days ago

Singleton services for easy data manipulation

Overview
Service is a singleton class instance which able to be used by any class using injection.
Defining class as a service
For setting class as a service the class must be decorated with the @Injectable() decorator, this will set the class as singleton.
@Injectable()
class MyService{
    public listeners:number = 0;
​
    public incListeners(){
        this.listeners++;
    }
​
    public decListeners(){
        this.listeners--;
    }
}
The service need to be set on the module services array:
@ServerModule({
    services: [MyService]
})
export class MyModule{
    constructor(){}
}
later we will be able to inject the service instance.
Service constructor cannot be defined with any arguments that are not injectable.
Injection types and aliasing
Overview
Using the module services we are able to define singleton services, constant values and factories for easy injection.
The module services support more informative data structure
{
    provide: Class |Factory method| Value,
    useName: string,
    type?:"constant"|"singleton"|"factory" // usually resolved automatically
}
Injection remains the same for all types
Examples
Singleton
Useful for getting the same instance of a class
@ServerModule({
    services: [
        MyService,
        {
            provide: MyNewService,
            useName: "MyServiceV2"
        }
    ]
})
export class MyModule{
    constructor(){}
}
Factory
Useful for getting different instances of the same class
@ServerModule({
    services: [
        MyService,
        {
            provide: () => new MyService(),
            useName: "MyServiceFactory"
        }
    ]
})
export class MyModule{
    constructor(){}
}
Constant
Useful for services instances (Redis, Socket e.g.) and configuration values
@ServerModule({
    services: [
        MyService,
        {
            provide: socketServer,
            useName: "SocketServer"
        }
    ]
})
export class MyModule{
    constructor(){}
}
​
​
​
​

@sugoi/server - Previous

Define a route (Controller)

Dynamic injectables

Setting services (Injectables)

Overview

Defining class as a service

Injection types and aliasing

Overview

Examples

Singleton

Factory

Constant

​

​