Documentation / @zerotal/admin / index / AdminGuardMiddleware
Class: AdminGuardMiddleware
Defined in: admin/src/provider/AdminGuardMiddleware.ts:18
Fail-closed default guard for the admin panel.
The panel exposes full CRUD, so shipping it with no guard is a footgun. When
config/admin.ts declares no middleware, the provider installs this guard
so the panel is denied by default in any production-like environment
(unset/unknown APP_ENV, staging, production). Local exploration
(APP_ENV=development|local|test) still passes through.
To run the panel in production, set middleware in config/admin.ts to a
real auth/authorization stack (e.g. [AuthMiddleware.with({ ... })]). To
deliberately expose it without auth, set an explicit pass-through
middleware — an intentional, visible opt-out rather than a silent default.
Extends
Constructors
Constructor
new AdminGuardMiddleware():
AdminGuardMiddleware
Defined in: core/src/middleware/BaseMiddleware.ts:36
Returns
AdminGuardMiddleware
Inherited from
Properties
options
protectedoptions:object={}
Defined in: admin/src/provider/AdminGuardMiddleware.ts:19
Subclasses must declare this with their default option values. TypeScript enforces this at compile time — forgetting it is a type error.
Overrides
Methods
handle()
handle(
_http,next):Promise<void|Response>
Defined in: admin/src/provider/AdminGuardMiddleware.ts:21
Parameters
_http
next
Returns
Promise<void | Response>
Overrides
with()
staticwith<T,Opts>(this,options): () =>InstanceType<T>
Defined in: core/src/middleware/BaseMiddleware.ts:48
Returns a zero-arg subclass with the given options deep-merged on top of the subclass defaults, usable directly in app.use([...]).
Type Parameters
T
T extends (...args) => BaseMiddleware<any>
Opts
Opts = T extends (...args) => BaseMiddleware<U> ? U : object
Parameters
this
T
options
Partial<Opts>
Returns
() => InstanceType<T>
Inherited from
afterResponse()?
optionalafterResponse(ctx):Promise<void>
Defined in: core/src/middleware/BaseMiddleware.ts:70
Parameters
ctx
Returns
Promise<void>
Inherited from
onError()?
optionalonError(ctx,error):Promise<void>
Defined in: core/src/middleware/BaseMiddleware.ts:71
Parameters
ctx
error
Error
Returns
Promise<void>