refactor: replace defineRoutes with defineRouter (#42)

Author: do4ng

README.md

@@ -41,9 +41,9 @@ project/
 ### Example
 
 ```ts
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
-export default defineRoutes((req, res) => {
+export default defineRouter((req, res) => {
   res.send('Hello from Dobs!');
 });
 ```
@@ -53,9 +53,9 @@ This route responds with `"Hello from Dobs!"` for all HTTP methods.
 If you want to handle methods separately:
 
 ```ts
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
-export default defineRoutes({
+export default defineRouter({
   GET(req, res) {
     res.send({ message: 'This is GET' });
   },

packages/create-dobs/with-typescript/app/[user]/index.ts

@@ -1,4 +1,4 @@
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
 interface User {
   nickname: string;
@@ -16,7 +16,7 @@ const USER_FAKE_DATA: Record<string, User> = {
   },
 };
 
-export default defineRoutes({
+export default defineRouter({
   GET(req, res) {
     const { user } = req.params;
     const user_data = USER_FAKE_DATA[user];

packages/create-dobs/with-typescript/app/index.ts

@@ -1,5 +1,5 @@
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
-export default defineRoutes({
+export default defineRouter({
   ALL: { message: 'Server is alive!' },
 });

packages/dobs/README.md

@@ -41,9 +41,9 @@ project/
 ### Example
 
 ```ts
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
-export default defineRoutes((req, res) => {
+export default defineRouter((req, res) => {
   res.send('Hello from Dobs!');
 });
 ```
@@ -53,9 +53,9 @@ This route responds with `"Hello from Dobs!"` for all HTTP methods.
 If you want to handle methods separately:
 
 ```ts
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
-export default defineRoutes({
+export default defineRouter({
   GET(req, res) {
     res.send({ message: 'This is GET' });
   },

packages/dobs/src/defineRoutes.ts

@@ -9,7 +9,23 @@ import { Routes } from './types';
  *    POST: { message: "hello world" } // static handler
  * });
  * ```
+ *
+ * @deprecated use `defineRouter()` instead
  */
 export function defineRoutes(routes: Routes, wrappers: any[] = []): Routes {
+  return defineRouter(routes, wrappers);
+}
+
+/**
+ * Define route object.
+ *
+ * ```ts
+ * export default defineRouter({
+ *    GET(req, res) { ... }, // dynamic handler
+ *    POST: { message: "hello world" } // static handler
+ * });
+ * ```
+ */
+export function defineRouter(routes: Routes, wrappers: any[] = []): Routes {
   return wrappers.reduce((acc, wrapper) => wrapper(acc), routes);
 }

packages/dobs/src/experimental/cache.ts

@@ -104,10 +104,10 @@ function createWrapper(
  *
  * @example
  * ```ts
- * import { defineRoutes } from "dobs";
+ * import { defineRouter } from "dobs";
  * import { useCache } from "dobs/experimental";
  *
- * export default defineRoutes((req, res) => {}, [useCache()])
+ * export default defineRouter((req, res) => {}, [useCache()])
  * ``` 
  * 
  * The values included in the ID generation are as follows: handler ID (GET, ALL, etc.) and pathname.

playgrounds/default/app/[user]/index.ts

@@ -1,4 +1,4 @@
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
 interface User {
   nickname: string;
@@ -16,7 +16,7 @@ const USER_FAKE_DATA: Record<string, User> = {
   },
 };
 
-export default defineRoutes({
+export default defineRouter({
   GET(req, res) {
     const { user } = req.params;
     const user_data = USER_FAKE_DATA[user];

playgrounds/default/app/index.ts

@@ -1,6 +1,6 @@
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
-export default defineRoutes({
+export default defineRouter({
   $GET(req, res) {
     setTimeout(() => {
       res.send('Dynamic Handler~!');

playgrounds/express/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@playgrounds/express"
+}

test/app/dynamic/[...params].ts

@@ -1,6 +1,6 @@
-import { defineRoutes } from 'dobs';
+import { defineRouter } from 'dobs';
 
-export default defineRoutes({
+export default defineRouter({
   GET(req, res) {
     res.send(`${req.params.params.join(',')}`);
   },