From defd40293f6210339f801498e3b36e751ac98e7d Mon Sep 17 00:00:00 2001 From: Emma Short Date: Sun, 1 Dec 2024 05:31:21 -0700 Subject: [PATCH] mod docs --- deno.json | 2 +- mod.ts | 7 ++++++- types.ts | 5 +++++ 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/deno.json b/deno.json index 05614e8..e0b44b4 100644 --- a/deno.json +++ b/deno.json @@ -1,7 +1,7 @@ { "name": "@bearmetal/router", "description": "A simple router for Deno", - "version": "0.1.2", + "version": "0.1.3", "stable": true, "repository": "https://github.com/emmaos/bearmetal", "files": [ diff --git a/mod.ts b/mod.ts index fa92574..7a61142 100644 --- a/mod.ts +++ b/mod.ts @@ -1 +1,6 @@ -export { Router } from "./router.ts"; \ No newline at end of file +/** + * @module + * BearMetal Router, for routing HTTP requests with Deno.serve + */ + +export { Router } from "./router.ts"; diff --git a/types.ts b/types.ts index 111c3e8..502bc2a 100644 --- a/types.ts +++ b/types.ts @@ -1,3 +1,8 @@ +/** + * @module + * BearMetal Router types + */ + export interface RouterContext { url: URL; params: Record;