feat: Add route options

Author: ardalanamini

__tests__/options.test.ts

@@ -0,0 +1,108 @@
+import Router from "../src";
+
+it("should return the empty options", () => {
+  const router = new Router();
+
+  const method = "GET";
+  const path = "/";
+  const handler = jest.fn();
+
+  router.on(method, path, handler);
+
+  const params = {};
+
+  const { handlers, allowHeader, options } = router.find("POST", path, params);
+
+  expect(handlers).toBeUndefined();
+  expect(allowHeader).toBe(method);
+  expect(options).toBeUndefined();
+  expect(params).toEqual({});
+});
+
+it("should return the default options", () => {
+  const router = new Router();
+
+  const method = "GET";
+  const path = "/";
+  const handler = jest.fn();
+
+  router.on(method, path, handler);
+
+  const params = {};
+
+  const { handlers, allowHeader, options } = router.find(method, path, params);
+
+  expect(handlers).toEqual([handler]);
+  expect(allowHeader).toBe(method);
+  expect(options).toEqual({ schema: { response: {} } });
+  expect(params).toEqual({});
+});
+
+it("should return the correct options", () => {
+  const router = new Router();
+
+  const method = "GET";
+  const path = "/";
+  const handler = jest.fn();
+
+  router.on(
+    method,
+    path,
+    {
+      schema: {
+        response: {
+          200: {
+            type: "string",
+            title: "Example Schema with string date-time field",
+          },
+        },
+      },
+    },
+    handler,
+  );
+
+  const params = {};
+
+  const { handlers, allowHeader, options } = router.find(method, path, params);
+
+  expect(handlers).toEqual([handler]);
+  expect(allowHeader).toBe(method);
+  expect(typeof options!.schema.response["200"]).toBe("function");
+  expect(params).toEqual({});
+});
+
+it("should respect sub-router options", () => {
+  const router = new Router();
+  const subRouter = new Router();
+
+  const method = "GET";
+  const path = "/";
+  const handler = jest.fn();
+
+  subRouter.on(
+    method,
+    path,
+    {
+      schema: {
+        response: {
+          200: {
+            type: "string",
+            title: "Example Schema with string date-time field",
+          },
+        },
+      },
+    },
+    handler,
+  );
+
+  router.use(subRouter);
+
+  const params = {};
+
+  const { handlers, allowHeader, options } = router.find(method, path, params);
+
+  expect(handlers).toEqual([handler]);
+  expect(allowHeader).toBe(method);
+  expect(typeof options!.schema.response["200"]).toBe("function");
+  expect(params).toEqual({});
+});

benchmarks/README.md

@@ -1,6 +1,6 @@
 {
   "name": "@foxify/router",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.2",
   "description": "Foxify Router",
   "homepage": "https://github.com/foxifyjs/router#readme",
   "repository": {
@@ -10,6 +10,9 @@
   "bugs": {
     "url": "https://github.com/foxifyjs/router/issues"
   },
+  "funding": {
+    "url": "https://opencollective.com/foxify"
+  },
   "license": "MIT",
   "author": {
     "name": "Ardalan Amini",
@@ -39,6 +42,10 @@
     "@foxify/http": "^1",
     "prototyped.js": "^1"
   },
+  "dependencies": {
+    "escape-html": "^1.0.3",
+    "fast-json-stringify": "^1.21.0"
+  },
   "devDependencies": {
     "@foxify/http": "^1.0.0-beta.2",
     "@foxify/inject": "^1.1.0",
@@ -54,8 +61,5 @@
   },
   "workspaces": [
     "benchmarks"
-  ],
-  "dependencies": {
-    "escape-html": "^1.0.3"
-  }
+  ]
 }