Router/types.ts
2024-12-01 05:31:21 -07:00

35 lines
920 B
TypeScript

/**
* @module
* BearMetal Router types
*/
export interface RouterContext {
url: URL;
params: Record<string, string | undefined>;
state: Record<string, unknown>;
pattern: URLPattern;
request: Request;
}
export type Handler = (req: Request, ctx: RouterContext) => Promise<Response> | Response;
export type Middleware = (ctx: RouterContext, next: () => Promise<Response>) => Promise<Response>;
export interface RouteConfig {
pattern: URLPattern;
handlers: { [method: string]: Handler };
}
export interface MiddlewareConfig {
pattern: URLPattern;
handler: Middleware;
path: string;
}
export interface RouteConfigurator {
get(handler: Handler): RouteConfigurator;
post(handler: Handler): RouteConfigurator;
put(handler: Handler): RouteConfigurator;
delete(handler: Handler): RouteConfigurator;
patch(handler: Handler): RouteConfigurator;
options(handler: Handler): RouteConfigurator;
}