Merge pull request #16 from rikilele/develop

v0.3.0-rc

.github/workflows/ci.yml

@@ -10,9 +10,13 @@ name: ci
 
 on:
   push:
-    branches: [main]
+    branches: 
+      - main
+      - develop
   pull_request:
-    branches: [main]
+    branches: 
+      - main
+      - develop
 
 jobs:
   test:

README.md

@@ -16,7 +16,7 @@ It aims to provide a similar experience to developing API servers with
 Deployed at https://kyuko.deno.dev
 
 ```ts
-import { Kyuko } from "https://deno.land/x/[email protected]";
+import { Kyuko } from "https://deno.land/x/[email protected]/mod.ts";
 
 const app = new Kyuko();
 

examples/errorHandling.ts

@@ -0,0 +1,18 @@
+// Copyright 2021 Riki Singh Khorana. All rights reserved. MIT license.
+
+import { Kyuko } from "../mod.ts";
+
+const app = new Kyuko();
+
+/**
+ * This will handle the error thrown.
+ */
+app.error((err, _req, res) => {
+  res.send(err.message);
+});
+
+app.get("/", (_req, _res) => {
+  throw new Error("An intentional error occurred!");
+});
+
+app.listen();

examples/middleware.ts

@@ -1,12 +1,20 @@
 // Copyright 2021 Riki Singh Khorana. All rights reserved. MIT license.
 
 import { Kyuko } from "../mod.ts";
+import { decodeParams } from "../middleware/decodeParams.ts";
 import { json, KyukoRequestWithJson } from "../middleware/json.ts";
 
 const app = new Kyuko();
 
-// Uses the `json` middleware
-app.use(json);
+app.use(decodeParams());
+app.use(json());
+
+/**
+ * Try accessing encoded url paths such as "/Alice%20%26%20Bob".
+ */
+app.get("/:name", (req, res) => {
+  res.send(`Hello ${req.params.name}!`);
+});
 
 /**
  * Responds with a pretty version of the JSON request body.

middleware/decodeParams.ts

@@ -0,0 +1,13 @@
+import { KyukoMiddleware, KyukoRequest } from "../mod.ts";
+
+/**
+ * Returns a `KyukoMiddleware` that decodes the values of `req.params`.
+ */
+export function decodeParams(): KyukoMiddleware {
+  return function (req: KyukoRequest) {
+    Object.keys(req.params).forEach((param) => {
+      const encoded = req.params[param];
+      req.params[param] = decodeURIComponent(encoded);
+    });
+  };
+}