/mod.ts | rutt@0.3.0

import * as rutt from "https://deno.land/x/rutt@0.3.0/mod.ts";

Rutt is a tiny http router designed for use with deno and deno deploy. It is written in about 300 lines of code and is fast enough, using an extended type of the web-standard URLPattern to provide fast and easy route matching.

Examples

Example 1

import { router } from "https://deno.land/x/rutt/mod.ts";

await Deno.serve(
  router({
    "/": (_req) => new Response("Hello world!", { status: 200 }),
  }),
).finished;

Variables

knownMethods

All known HTTP methods.

Functions

f buildInternalRoutes	Builds an InternalRoutes array from a Routes record.
f defaultErrorHandler	The default error handler for the router. By default it responds with `null` body and a status of 500 along with `console.error` logging the caught error.
f defaultOtherHandler	The default other handler for the router. By default it responds with `null` body and a status of 404.
f defaultUnknownMethodHandler	The default unknown method handler for the router. By default it responds with `null` body, a status of 405 and the `Accept` header set to all known methods.
f router	A simple and tiny router for deno. This function provides a way of constructing a HTTP request handler for the provided routes and any provided RouterOptions.

Interfaces

I InternalRoute	The internal route object contains either a RegExp pattern or URLPattern which is matched against the incoming request URL. If a match is found for both the pattern and method the associated MatchHandler is called.
I RouterOptions	Additional options for the router function.
I Routes	A record of route paths and MatchHandlers which are called when a match is found along with it's values.

Type Aliases

T ErrorHandler	A handler type for anytime the `MatchHandler` or `other` parameter handler fails
T Handler	A handler for HTTP requests. Consumes a request and HandlerContext and returns an optionally async response.
T HandlerContext	Provides arbitrary context to Handler functions along with ConnInfo \| connection information.
T InternalRoutes	An array of internal route objects which the routes record is mapped into. This array is used internally in the router function and can even be passed directly to it if you do not wish to use the routes record or want more fine grained control over matches, for example by using a RegExp pattern instead of a URLPattern.
T KnownMethod	A known HTTP method.
T MatchHandler	A handler type for a router path match which gets passed the matched values
T UnknownMethodHandler	A handler type for anytime a method is received that is not defined