Documentation / @zerotal/core / index / ServiceProvider
Abstract Class: ServiceProvider
Defined in: provider/ServiceProvider.ts:13
Base class for service providers: register bindings and observe the app lifecycle.
Extended by
LockProviderLogProviderStorageProviderAdminProviderAuditProviderAuthProviderSocialProviderBroadcastProviderCacheProviderClientProviderDevtoolsProviderFlowProviderFlowUiProviderI18nProviderInertiaProviderMonitorProviderNotificationProviderDatabaseProviderQueueProviderSchedulerProviderSessionProviderTelemetryProviderTenancyProvider
Constructors
Constructor
new ServiceProvider(
app):ServiceProvider
Defined in: provider/ServiceProvider.ts:44
Parameters
app
Returns
ServiceProvider
Properties
environments
staticenvironments:AppEnvironment[]
Defined in: provider/ServiceProvider.ts:15
Environments in which this provider is active. Defaults to all of them.
provides?
staticoptionalprovides?: readonly keyofContainerBindings[]
Defined in: provider/ServiceProvider.ts:24
Container tokens this provider registers. Required when using the array form of app.defer([Provider, ...]).
Example
static override provides = ['cache'] as const;
dependsOn?
staticoptionaldependsOn?: (app) =>ServiceProvider[]
Defined in: provider/ServiceProvider.ts:35
Other providers this one needs. They are pulled into the application automatically (transitively, de-duplicated) and guaranteed to boot before this provider — so you only have to register the feature you want, not its plumbing. Reference the provider classes directly:
Parameters
app
Returns
ServiceProvider
Example
static override dependsOn = [FlowProvider];
priority?
staticoptionalpriority?:number
Defined in: provider/ServiceProvider.ts:42
Boot-order tiebreak among providers with no dependsOn relationship.
Lower boots earlier; defaults to 0. Handy for framework-core providers
(e.g. static override priority = -100).
app
protectedapp:Application
Defined in: provider/ServiceProvider.ts:44
Methods
onRegister()
onRegister():
void
Defined in: provider/ServiceProvider.ts:47
Register container bindings. Runs before any provider boots; do not resolve services here.
Returns
void
onBooting()
onBooting():
Promise<void>
Defined in: provider/ServiceProvider.ts:49
Resolve and prepare services before the app is considered booted.
Returns
Promise<void>
onBooted()
onBooted():
Promise<void>
Defined in: provider/ServiceProvider.ts:51
Run once all providers have booted and every binding is available.
Returns
Promise<void>
onStarting()
onStarting():
Promise<void>
Defined in: provider/ServiceProvider.ts:53
Run just before the app starts accepting work (e.g. the HTTP server).
Returns
Promise<void>
onStarted()
onStarted():
Promise<void>
Defined in: provider/ServiceProvider.ts:55
Run once the app has started.
Returns
Promise<void>
onStopping()
onStopping():
Promise<void>
Defined in: provider/ServiceProvider.ts:57
Run when the app begins a graceful shutdown; release resources here.
Returns
Promise<void>
onStopped()
onStopped():
Promise<void>
Defined in: provider/ServiceProvider.ts:59
Run once shutdown is complete.
Returns
Promise<void>
onRequestReceived()
onRequestReceived(
_ctx):Promise<void>
Defined in: provider/ServiceProvider.ts:66
Called before the middleware pipeline runs.
Parameters
_ctx
Returns
Promise<void>
onRequestProcessed()
onRequestProcessed(
_ctx):Promise<void>
Defined in: provider/ServiceProvider.ts:69
Called after the pipeline completes and ctx.response is set.
Parameters
_ctx
Returns
Promise<void>
onResponseSent()
onResponseSent(
_ctx):Promise<void>
Defined in: provider/ServiceProvider.ts:72
Called after the response has been sent to the client.
Parameters
_ctx
Returns
Promise<void>
replContext()
replContext():
Record<string,unknown>
Defined in: provider/ServiceProvider.ts:81
Variables to expose in bun zt repl.
Override in any provider to make its facades available by name in the REPL session.
Returns
Record<string, unknown>
Example
override replContext() { return { DB, Mail }; }