HttpArc

class HttpArc<TLifecycle extends HostRuntimeLifecycle = "async"> extends HttpBase

Top-level application entry point.

Extends HttpBase with group for registering prefixed route groups and run for handing control to the runtime selected by the build pipeline.

How you get one

Handed to you by the framework; see HTTP.

Methods

after()

2 overloads

after(handler: HttpAfterHandler): void

handler HttpAfterHandler

after<D extends InjectMap>(options: HttpMiddlewareOptions<D>, handler: (ctx: FlareHttpContext, result: HandlerResult, scope: HandlerScope<D>) => MiddlewareOverride | Promise<MiddlewareOverride>): void

options HttpMiddlewareOptions<D>

handler (ctx: FlareHttpContext, result: HandlerResult, scope: HandlerScope<D>) => MiddlewareOverride | Promise<MiddlewareOverride>

before()

2 overloads

before(handler: HttpBeforeHandler): void

handler HttpBeforeHandler

before<D extends InjectMap>(options: HttpMiddlewareOptions<D>, handler: (ctx: FlareHttpContext, scope: HandlerScope<D>) => MiddlewareOverride | Promise<MiddlewareOverride>): void

options HttpMiddlewareOptions<D>

handler (ctx: FlareHttpContext, scope: HandlerScope<D>) => MiddlewareOverride | Promise<MiddlewareOverride>

delete()

2 overloads

delete(path: string, handler: HttpRouteHandler): void

path string

handler HttpRouteHandler

delete<O extends HttpRouteOptions>(path: string, options: O, handler: (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>): void

path string

options O

handler (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>

error()

3 overloads

error(handler: ErrorHandlerClass): void

handler ErrorHandlerClass

error(handler: HttpErrorHandler): void

handler HttpErrorHandler

error<D extends InjectMap>(options: HttpErrorHandlerOptions<D>, handler: (err: FlareError<undefined> | Error, context: HttpErrorContext, scope: HandlerScope<D>) => void | ResponseLike | Promise<void | ResponseLike>): void

options HttpErrorHandlerOptions<D>

handler (err: FlareError<undefined> | Error, context: HttpErrorContext, scope: HandlerScope<D>) => void | ResponseLike | Promise<void | ResponseLike>

finally()

2 overloads

finally(handler: HttpFinallyHandler): void

handler HttpFinallyHandler

finally<D extends InjectMap>(options: HttpMiddlewareOptions<D>, handler: (ctx: FlareHttpContext, result: HandlerResult, scope: HandlerScope<D>) => MiddlewareOverride | Promise<MiddlewareOverride>): void

options HttpMiddlewareOptions<D>

handler (ctx: FlareHttpContext, result: HandlerResult, scope: HandlerScope<D>) => MiddlewareOverride | Promise<MiddlewareOverride>

get()

2 overloads

get(path: string, handler: HttpRouteHandler): void

path string

handler HttpRouteHandler

get<O extends HttpRouteOptions>(path: string, options: O, handler: (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>): void

path string

options O

handler (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>

group()

group(prefix: string, builder: HttpGroupFn): void

Registers a route group under a shared path prefix.

The builder receives a HttpGroup instance, a full HttpBase that can have its own middleware, controllers, and nested groups. Registrations made inside the builder are scoped to prefix.

prefix string · The path prefix applied to every route registered inside the group (e.g. "/api/v1").

builder HttpGroupFn · A function that configures the group and returns a GroupRegistration.

head()

2 overloads

head(path: string, handler: HttpRouteHandler): void

path string

handler HttpRouteHandler

head<O extends HttpRouteOptions>(path: string, options: O, handler: (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>): void

path string

options O

handler (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>

onStart()

onStart(fn: LifecycleCallback<TLifecycle>): void

Registers a callback to be invoked when the application starts.

Callbacks are called in registration order during app startup.

fn LifecycleCallback<TLifecycle>

onStop()

onStop(fn: LifecycleCallback<TLifecycle>): void

Registers a callback to be invoked when the application stops.

Callbacks are called in registration order during graceful shutdown.

fn LifecycleCallback<TLifecycle>

options()

2 overloads

options(path: string, handler: HttpRouteHandler): void

path string

handler HttpRouteHandler

options<O extends HttpRouteOptions>(path: string, options: O, handler: (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>): void

path string

options O

handler (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>

patch()

2 overloads

patch(path: string, handler: HttpRouteHandler): void

path string

handler HttpRouteHandler

patch<O extends HttpRouteOptions>(path: string, options: O, handler: (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>): void

path string

options O

handler (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>

post()

2 overloads

post(path: string, handler: HttpRouteHandler): void

path string

handler HttpRouteHandler

post<O extends HttpRouteOptions>(path: string, options: O, handler: (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>): void

path string

options O

handler (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>

put()

2 overloads

put(path: string, handler: HttpRouteHandler): void

path string

handler HttpRouteHandler

put<O extends HttpRouteOptions>(path: string, options: O, handler: (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>): void

path string

options O

handler (ctx: FlareHttpContext, scope: HttpHandlerScope<InjectOf<O>, DescriptorOf<O>>) => HandlerResult | Promise<HandlerResult>

Learn: HTTP