Angular Provide Once

🔂 Removes the need to use forRoot in Angular 2+ modules by providing guaranteed singleton services.

• Complete changelog

Description

• No .forRoot(): Allows module consumers to import without calling a forRoot method
• Singletons: Allows module creators to provide singleton services that don't require consumers to be concerned with accidentally providing multiple instances
• Top level: If multiple instances are attempted, the top level instance in the provider tree will be used
• Multiple consumers: If multiple libraries depend on your service and those libraries are used in a single Angular project, you can still guarantee a single instance of your service

Install

npm install angular-provide-once --save

Usage in @NgModule

import { NgModule } from '@angular/core';
import { ProvideOnce } from 'angular-provide-once';
 
import { DependantService } from './dependant-service';
import { MyService } from './my-service';
import { OtherService } from './other-service';
 
@NgModule({
  imports: [],
  providers: [
    OtherService,
    DependantService,
    ...ProvideOnce(MyService, [DependantService])
  ],
  declarations: []
})
export class MyModule { }

Api

...ProvideOnce(targetService[, dependencyArray])

Paramaters

targetService

The service that should be provided once.

dependencyArray

An optional array of services that the targetService depends on. Only include immediate dependencies (not dependencies of dependencies).

Return value

ProvideOnce returns an array of Providers. Use the spread operator (e.g. ...ProvideOnce) to include it along with other services.

License

angular-provide-once is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.