Documentation / @zerotal/admin / index / AdminProvider

Class: AdminProvider

Defined in: admin/src/provider/AdminProvider.ts:53

Base class for service providers: register bindings and observe the app lifecycle.

Extends

ServiceProvider

Constructors

Constructor

new AdminProvider(app): AdminProvider

Defined in: core/src/provider/ServiceProvider.ts:44

Parameters

app

Application

Returns

AdminProvider

Inherited from

ServiceProvider.constructor

Properties

provides

static provides: readonly ["admin.panel"]

Defined in: admin/src/provider/AdminProvider.ts:54

Container tokens this provider registers. Required when using the array form of app.defer([Provider, ...]).

Example

static override provides = ['cache'] as const;

Overrides

ServiceProvider.provides

dependsOn

static dependsOn: typeof FlowProvider[]

Defined in: admin/src/provider/AdminProvider.ts:57

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:

Example

static override dependsOn = [FlowProvider];

Overrides

ServiceProvider.dependsOn

environments

static environments: AppEnvironment[]

Defined in: admin/src/provider/AdminProvider.ts:63

Environments in which this provider is active. Defaults to all of them.

Overrides

ServiceProvider.environments

priority?

static optional priority?: number

Defined in: core/src/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).

Inherited from

ServiceProvider.priority

app

protected app: Application

Defined in: core/src/provider/ServiceProvider.ts:44

Inherited from

ServiceProvider.app

Methods

onRegister()

onRegister(): void

Defined in: admin/src/provider/AdminProvider.ts:65

Returns

void

Overrides

ServiceProvider.onRegister

onBooting()

onBooting(): Promise<void>

Defined in: admin/src/provider/AdminProvider.ts:86

Resolve and prepare services before the app is considered booted.

Returns

Promise<void>

Overrides

ServiceProvider.onBooting

onBooted()

onBooted(): Promise<void>

Defined in: admin/src/provider/AdminProvider.ts:125

Mount the panel's routes.

Deferred to onBooted because contributions arrive during the booting phase: every provider's onBooting has run by now, so the page registry is complete and each contributed page gets a route.

Returns

Promise<void>

Overrides

ServiceProvider.onBooted

onStopping()

onStopping(): Promise<void>

Defined in: admin/src/provider/AdminProvider.ts:170

Run when the app begins a graceful shutdown; release resources here.

Returns

Promise<void>

Overrides

ServiceProvider.onStopping

onStarting()

onStarting(): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:53

Run just before the app starts accepting work (e.g. the HTTP server).

Returns

Promise<void>

Inherited from

ServiceProvider.onStarting

onStarted()

onStarted(): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:55

Run once the app has started.

Returns

Promise<void>

Inherited from

ServiceProvider.onStarted

onStopped()

onStopped(): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:59

Run once shutdown is complete.

Returns

Promise<void>

Inherited from

ServiceProvider.onStopped

onRequestReceived()

onRequestReceived(_ctx): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:66

Called before the middleware pipeline runs.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onRequestReceived

onRequestProcessed()

onRequestProcessed(_ctx): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:69

Called after the pipeline completes and ctx.response is set.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onRequestProcessed

onResponseSent()

onResponseSent(_ctx): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:72

Called after the response has been sent to the client.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onResponseSent

replContext()

replContext(): Record<string, unknown>

Defined in: core/src/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 }; }

Inherited from

ServiceProvider.replContext