service-providers.md

Service providers allow to us to bind things to our application. In fact Varie it self uses service providers to boot all the necessary components to create the actual application. These providers are meant for registering services, middleware constants, routes and more. Most of the application providers are deferred and are only loaded when actually called from the container.

Creating a Service Provider

Each provider extends the varie/lib/support/ServiceProvider class. The service provider will require the use of the register method and optionally the boot method. Register should only bind things into the service container.

The Varie CLI tool can generate a new service provider for you

$ varie make:provider <provider-name>

The Register Method

The register method is meant to bind things to the service container. You can review how to bind things to the container in the service container documentation.

    import { injectable } from "inversify";
    import ServiceProvider from "varie/lib/support/ServiceProvider";
    import DocumentationService from "@app/services/DocumentationService";

    @injectable()
    export default class DocumentationProvider extends ServiceProvider {
      public register() {
        this.app.singleton("DocumentationService", DocumentationService);
        this.app.singleton("DocumentationService", DocumentationService);
      }
    }

Above the provider is binding a implementation of a $documentationService to the container.

The Boot Method

The boot method occurs after ALL service providers have been registered and have availability to them through the service container.

Registering Service Providers

All service providers are registered in config/app. This file contains other service providers already added to application.

 providers: {
    /*
     * Varie Framework Service Providers...
     */
    ConfigServiceProvider,
    CookieServiceProvider,
    StorageServiceProvider,
    HttpServiceProvider,
    StateServiceProvider,
    RoutingServiceProvider,
    ...

    DocumentationProvider,

    ...


  }