Documentation
    Preparing search index...

    Interface ContainerProviderContract

    Contract for service provider classes. Service providers are used to register bindings in the IoC container and boot application services during different lifecycle phases.

    export default class MyProvider implements ContainerProviderContract {
      register() {
        this.app.container.singleton('myService', () => new MyService())
      }

      boot() {
        // Boot logic
      }
    }
    interface ContainerProviderContract {
        register?(): void;
        boot?(): AsyncOrSync<void>;
        start?(): AsyncOrSync<void>;
        ready?(): AsyncOrSync<void>;
        shutdown?(): AsyncOrSync<void>;
    }
    Index

    Methods

    register? boot? start? ready? shutdown?

    Methods

    • The register method is called to register bindings in the IoC container. This is where you should bind services, singletons, and other dependencies.

      Returns void

    • The boot method is called to boot application state. Use this method for registering macros, middleware, REPL bindings, and other application-level configurations.

      Returns AsyncOrSync<void>

    • The start method is called after all providers have been booted. This is the ideal place to use existing container bindings and perform startup operations that depend on other services.

      Returns AsyncOrSync<void>

    • The ready method is called when the application is fully ready. For HTTP servers, this is called after the server starts listening. Preloaded files have been imported and the app is ready to serve requests.

      Returns AsyncOrSync<void>

    • The shutdown method is called during graceful application shutdown. Use this method to clean up resources, close connections, and perform other cleanup tasks. Avoid long-running operations to prevent forceful termination.

      Returns AsyncOrSync<void>

    Settings

    Member Visibility

    On This Page

    Methods