import { Context } from '@worker-tools/middleware'; import type { URLPatternInit, URLPatternComponentResult, URLPatternInput, URLPatternResult } from '@worker-tools/middleware'; export type { URLPatternInit, URLPatternComponentResult, URLPatternInput, URLPatternResult }; export declare type Awaitable = T | PromiseLike; export interface RouteContext extends Context { /** * The match that resulted in the execution of this route. It is the full result produced by the URL Pattern API. * If you are looking for a `params`-like object similar to outer routers, use the `basics` middleware * or `match.pathname.groups`. */ match: URLPatternResult; } export interface ErrorContext extends RouteContext { /** * If the exception is well-known and caused by middleware, this property is populated with a `Response` object * with an appropriate status code and text set. * * You can use it to customize the error response, e.g.: `new Response('...', response)`. */ response: Response; /** * If an unknown error occurred, the sibling `response` property is set to be an "internal server error" while * the `error` property contains thrown error. */ error?: unknown; } export declare type Middleware = (x: Awaitable) => Awaitable; export declare type Handler = (request: Request, ctx: X) => Awaitable; export declare type ErrorHandler = (request: Request, ctx: X) => Awaitable; export declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS'; export interface WorkerRouterOptions { fatal?: boolean; } export declare class WorkerRouter extends EventTarget implements EventListenerObject { #private; constructor(middleware?: Middleware | null, opts?: WorkerRouterOptions); get fatal(): boolean; /** Add a route that matches *any* HTTP method. */ any(path: string, handler: Handler): this; any(path: string, middleware: Middleware, handler: Handler): this; /** Alias for for the more appropriately named `any` method */ all(path: string, handler: Handler): this; all(path: string, middleware: Middleware, handler: Handler): this; /** Add a route that matches the `GET` method. */ get(path: string, handler: Handler): this; get(path: string, middleware: Middleware, handler: Handler): this; /** Add a route that matches the `POST` method. */ post(path: string, handler: Handler): this; post(path: string, middleware: Middleware, handler: Handler): this; /** Add a route that matches the `PUT` method. */ put(path: string, handler: Handler): this; put(path: string, middleware: Middleware, handler: Handler): this; /** Add a route that matches the `PATCH` method. */ patch(path: string, handler: Handler): this; patch(path: string, middleware: Middleware, handler: Handler): this; /** Add a route that matches the `DELETE` method. */ delete(path: string, handler: Handler): this; delete(path: string, middleware: Middleware, handler: Handler): this; /** Add a route that matches the `HEAD` method. */ head(path: string, handler: Handler): this; head(path: string, middleware: Middleware, handler: Handler): this; /** Add a route that matches the `OPTIONS` method. */ options(path: string, handler: Handler): this; options(path: string, middleware: Middleware, handler: Handler): this; /** * Add a route that matches *any* method with the provided pattern. * Note that the pattern here is interpreted as a `URLPatternInit` which has important implication for matching. * Mostly, this is for use in Service Workers to intercept requests to external resources. * * The name `external` is a bit of a misnomer. It simply forwards `init` to the `URLPattern` constructor, * instead of being limited to the `pathname` property in the general case. * @deprecated Might change name/API */ external(init: string | URLPatternInit, handler: Handler): this; external(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** Like `.external`, but only matches `GET` * @deprecated Might change name/API */ externalGET(init: string | URLPatternInit, handler: Handler): this; externalGET(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** Like `.external`, but only matches `POST` * @deprecated Might change name/API */ externalPOST(init: string | URLPatternInit, handler: Handler): this; externalPOST(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** Like `.external`, but only matches `PUT` * @deprecated Might change name/API */ externalPUT(init: string | URLPatternInit, handler: Handler): this; externalPUT(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** Like `.external`, but only matches `PATCH` * @deprecated Might change name/API */ externalPATCH(init: string | URLPatternInit, handler: Handler): this; externalPATCH(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** Like `.external`, but only matches `DELETE` * @deprecated Might change name/API */ externalDELETE(init: string | URLPatternInit, handler: Handler): this; externalDELETE(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** Like `.external`, but only matches `OPTIONS` * @deprecated Might change name/API */ externalOPTIONS(init: string | URLPatternInit, handler: Handler): this; externalOPTIONS(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** Like `.external`, but only matches `HEAD` * @deprecated Might change name/API */ externalHEAD(init: string | URLPatternInit, handler: Handler): this; externalHEAD(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** * Use a different `WorkerRouter` for the provided pattern. Keep in mind that: * * - The pattern must end in a wildcard `*` * - The corresponding match is the only part used for matching in the `subRouter` * - Forwards all HTTP methods * - Does not apply any middleware * * #### Why does it not apply middleware? * * There are 2 reasons: First, it interferes with type inference of middleware. * As a developer you'd have to provide the correct types at the point of defining the sub router, * which is at least as cumbersome as providing the middleware itself. * * Second, without this there would be no way to opt a route out of the router-level middleware. * For example you might want to opt out all `/public*` urls from cookie parsing, authentication, etc. * but add a different caching policy instead. * * @param path A pattern ending in a wildcard, e.g. `/items*` * @param subRouter A `WorkerRouter` that handles the remaining part of the URL, e.g. `/:category/:id` * @deprecated The name of this method might change to avoid confusion with `use` method known from other routers. */ use(path: string, subRouter: WorkerRouter): this; /** * See `.external` and `.use`. * @deprecated Might change name/API */ useExternal(init: string | URLPatternInit, subRouter: WorkerRouter): this; /** * Register a special route to recover from an error during execution of a regular route. * * In addition to the usual context properties, the provided handler receives a `response` and `error` property. * In case of a well-known error (typically caused by middleware), * the `response` contains a Fetch API `Response` object with matching status and status text set. * In case of an unknown error, the `response` is a generic "internal server error" and the `error` property * contains the value caught by the catch block. * * Recover routes don't execute the router-level middleware (which might have caused the error), but * can have middleware specifically for this route. Note that if another error occurs during the execution of * this middleware, there are no more safety nets and an internal server error response is returned. * * If a global `DEBUG` variable is set (or `process.env.NODE_ENV` is set to `development` in case of webpack) * the router will throw on an unhandled error. This is to make it easier to spot problems during development. * Otherwise, the router will not throw but instead dispatch a `error` event on itself before returning an empty * internal server error response. */ recover(path: string, handler: Handler): this; recover(path: string, middleware: Middleware, handler: Handler): this; recoverExternal(init: string | URLPatternInit, handler: Handler): this; recoverExternal(init: string | URLPatternInit, middleware: Middleware, handler: Handler): this; /** @deprecated Name/API might change */ handle: (request: Request, ctx?: Omit) => Promise; /** * Implements the (ancient) event listener object interface to allow passing to fetch event directly, * e.g. `self.addEventListener('fetch', router)`. */ handleEvent: (object: Event) => void; /** * Callback compatible with Cloudflare Worker's `fetch` module export. * E.g. `export default router`. */ fetch: (request: Request, env?: any, ctx?: any) => Promise; /** * Callback that is compatible with Deno's `serve` function. * E.g. `serve(router.serveCallback)`. */ serveCallback: (request: Request, connInfo: any) => Promise; addEventListener(type: 'error', listener: TypedEventListenerOrEventListenerObject | null, options?: boolean | AddEventListenerOptions): void; removeEventListener(type: 'error', listener: TypedEventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void; } declare type TypedEventListener = (evt: E) => void | Promise; declare type TypedEventListenerObject = { handleEvent(evt: E): void | Promise; }; declare type TypedEventListenerOrEventListenerObject = TypedEventListener | TypedEventListenerObject;