Skip to content

Latest commit

 

History

History
415 lines (240 loc) · 14.1 KB

routerUtils.md

File metadata and controls

415 lines (240 loc) · 14.1 KB
Raw

routerUtils

Classes

Router

Simple router that handles both eager- and lazy-loaded route handlers to keep your bundle sizes small. Both default and named module exports are supported with a concise syntax. Appends Server-Timing values for route loading duration to the request headers; can be disabled via the constructor.

Path matches follow glob rules by using Bun.Glob; see the documentation for Bun.Glob for details.

Example

import { Router } from '@mangs/bun-utils/router';

const router = new Router();
router
  .get('/*', { default: () => import('./routes/pageRoute.mts') })                  // Lazy-loaded, default module export route handler
  .post('/submit', { submitRoute: () => import('./routes/submitRoute.mts') })      // Lazy-loaded, named module export route handler
  .get('/**', () => new Response('404 page', { status: 404 }))                     // Eagerly-loaded route handler
  .all('/**', () => new Response('', { headers: { allow: 'GET' }, status: 405 })); // Eagerly-loaded route handler

Constructors

new Router()

new Router(usesServerTiming): Router

Constructor that creates an empty array for route definitions.

Parameters
Parameter Type Default value Description
usesServerTiming boolean true Boolean indicating if Server-Timing headers are appended to the request object.
Returns

Router

Source

src/routerUtils.mts:60

Properties

Property Modifier Type Description
#routes private Routes Array of route tuples.
#usesServerTiming private boolean Whether or not Server-Timing headers are appended to the Request object.

Methods

#handleMethod()

private #handleMethod(path, routeHandler, method): Router

Register a route handler for the specified HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
method "ALL" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT" A valid HTTP method.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Source

src/routerUtils.mts:141

all()

all(path, routeHandler): Router

Register a route handler that matches all HTTP request methods.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.all('/**', () => new Response('', { headers: { allow: 'GET' }, status: 405 }));
Source

src/routerUtils.mts:159

delete()

delete(path, routeHandler): Router

Register a route handler that matches the DELETE HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.delete('/item', { deleteItemRoute: () => import('./routes/deleteItemRoute.mts') })
Source

src/routerUtils.mts:173

get()

get(path, routeHandler): Router

Register a route handler that matches the GET HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.get('/*', { pageRoute: () => import('./routes/pageRoute.mts') })
Source

src/routerUtils.mts:187

handleRequest()

handleRequest(request): Promise<Response>

Handles the incoming request after all route definitions have been made.

Parameters
Parameter Type Description
request Request The Request object for the incoming request.
Returns

Promise<Response>

A Response object to build the response sent to the requester.

Source

src/routerUtils.mts:94

head()

head(path, routeHandler): Router

Register a route handler that matches the HEAD HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.head('/*', { pageRoute: () => import('./routes/pageRoute.mts') })
Source

src/routerUtils.mts:201

options()

options(path, routeHandler): Router

Register a route handler that matches the OPTIONS HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.options('/item', { deleteItemRoute: () => import('./routes/deleteItemRoute.mts') })
Source

src/routerUtils.mts:215

patch()

patch(path, routeHandler): Router

Register a route handler that matches the PATCH HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.patch('/item', { patchItemRoute: () => import('./routes/patchItemRoute.mts') })
Source

src/routerUtils.mts:229

post()

post(path, routeHandler): Router

Register a route handler that matches the POST HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.post('/item', { postItemRoute: () => import('./routes/postItemRoute.mts') })
Source

src/routerUtils.mts:243

put()

put(path, routeHandler): Router

Register a route handler that matches the PUT HTTP request method.

Parameters
Parameter Type Description
path string A path-like string that will be used to match against the incoming request's path.
routeHandler RouteHandler The function that will execute if this route handler is matched. Eagerly-loaded route handlers pass functions in directly; lazy-loaded ones pass in an object whose key corresponds to a module's named export or 'default' for default export.
Returns

Router

A reference to the instantiated instance (this) so route handler definitions can be chained.

Example
router.put('/item', { putItemRoute: () => import('./routes/putItemRoute.mts') })
Source

src/routerUtils.mts:257

Type Aliases

HttpRequestMethod

HttpRequestMethod: typeof httpRequestMethods[number]

Source

src/routerUtils.mts:12

RouteEntry

RouteEntry: Parameters<InstanceType<typeof Router>["get"]>

Source

src/routerUtils.mts:16

RouteHandler

RouteHandler: RouteHandlerFunction | RouteHandlerLazyLoaded

Source

src/routerUtils.mts:15

RouteHandlerFunction()

RouteHandlerFunction: (request) => Response | Promise<Response>

Parameters

Parameter Type
request Request

Returns

Response | Promise<Response>

Source

src/routerUtils.mts:13

RouteHandlerLazyLoaded

RouteHandlerLazyLoaded: Record<string, () => Promise<Record<string, RouteHandlerFunction>>>

Source

src/routerUtils.mts:14

Routes

Routes: [HttpRequestMethod, RouteEntry][]

Source

src/routerUtils.mts:17

Variables

httpRequestMethods

const httpRequestMethods: readonly ["ALL", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"]

Source

src/routerUtils.mts:20