defineRoute

Creates a typed route definition for a single path and HTTP method. Use it to describe routes before passing a collection to compileRoutes or createServer.

The returned object is frozen, so route definitions are treated as static configuration after creation.

Importing

import { defineRoute } from '@almighty-shogun/bun-server';

Usage

import { defineRoute } from '@almighty-shogun/bun-server';

const route = defineRoute('/users/:id', 'GET', (request, response) => {
    return response.json({ id: request.params.id });
});

TIP

You can pass either HttpMethod.Get or the equivalent 'GET' method string.

Route handler

The handler receives three arguments: Bun's typed BunRequest, which is a Request carrying the decoded params for the path; the HttpResponse class with its static factory methods; and the active Bun.Server.

The path is a literal type, so parameter names come straight out of it. A path of '/users/:userId/posts/:postId' gives params the type { userId: string; postId: string }.

Handlers must resolve to an HttpResponse. Returning a native Response throws an InvalidHandlerResultError naming the offending method and path.

Parameters

path: Path
Route path passed to Bun's typed request handler.

method: Method
HTTP method handled by the route.

handler: RouteHandler<Path, WebSocketData>
Handler that receives the Bun request, response factory, and Bun server.

Returns

An immutable route definition that can be included in a route collection.

Uses

• HttpMethod

Type signature

declare function defineRoute<
    const Path extends string,
    const Method extends HttpMethod,
    WebSocketData = undefined
>(
    path: Path,
    method: Method,
    handler: RouteHandler<Path, WebSocketData>
): RouteDefinition<Path, Method, WebSocketData>;