Interface RootLifecycleService

Registration of backend startup and shutdown lifecycle hooks.

See the service documentation for more details.

interface RootLifecycleService {
    addBeforeShutdownHook(hook: () => void | Promise<void>): void;
    addShutdownHook(
        hook: LifecycleServiceShutdownHook,
        options?: LifecycleServiceShutdownOptions,
    ): void;
    addStartupHook(
        hook: LifecycleServiceStartupHook,
        options?: LifecycleServiceStartupOptions,
    ): void;
}

Hierarchy (View Summary)

LifecycleService
- RootLifecycleService

Index

Methods

addBeforeShutdownHook addShutdownHook addStartupHook

Methods

addBeforeShutdownHook

addBeforeShutdownHook(hook: () => void | Promise<void>): void
Parameters
- hook: () => void | Promise<void>
Returns void
- Defined in packages/backend-plugin-api/src/services/definitions/RootLifecycleService.ts:27

addShutdownHook

addShutdownHook(
hook: LifecycleServiceShutdownHook,
options?: LifecycleServiceShutdownOptions,
): void
Register a function to be called when the backend is shutting down.
Parameters
- hook: LifecycleServiceShutdownHook
- Optionaloptions: LifecycleServiceShutdownOptions
Returns void
Inherited from LifecycleService.addShutdownHook
- Defined in packages/backend-plugin-api/src/services/definitions/LifecycleService.ts:74

addStartupHook

addStartupHook(
hook: LifecycleServiceStartupHook,
options?: LifecycleServiceStartupOptions,
): void
Register a function to be called when the backend has been initialized.
Parameters
- hook: LifecycleServiceStartupHook
- Optionaloptions: LifecycleServiceStartupOptions
Returns void
Remarks
When used with plugin scope it will wait for the plugin itself to have been initialized.

When used with root scope it will wait for all plugins to have been initialized.
Inherited from LifecycleService.addStartupHook
- Defined in packages/backend-plugin-api/src/services/definitions/LifecycleService.ts:66