chore: add remarks comment

pingdotgg · Jun 14, 2024 · 14ab7ce · 14ab7ce
1 parent 4eb3ec1
commit 14ab7ce
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/examples/backend-adapters/server/package.json b/examples/backend-adapters/server/package.json
@@ -8,7 +8,8 @@
     "dev:express": "NODE_ENV=development tsx watch src/express.ts",
     "dev:fastify": "NODE_ENV=development tsx watch src/fastify.ts",
     "dev:hono": "NODE_ENV=development tsx watch src/hono.ts",
-    "dev:h3": "NODE_ENV=development listhen -w src/h3.ts"
+    "dev:h3": "NODE_ENV=development listhen -w src/h3.ts",
+    "dev:effect": "NODE_ENV=development bun run src/effect.ts"
   },
   "dependencies": {
     "@effect/platform": "^0.57.1",

diff --git a/examples/backend-adapters/server/src/router.ts b/examples/backend-adapters/server/src/router.ts
@@ -1,3 +1,13 @@
+/**
+ * @remarks Note that this router uses the `/server` entrypoint
+ * but we re-use it even for adapters like Express, Fastify and H3.
+ * The middleware options will therefore not be accurate, but
+ * for this example we don't care and don't want to duplicate
+ * the router for every adapter.
+ *
+ * In your app, import using the correct entrypoint for your adapter.
+ * @see https://docs.uploadthing.com/api-reference/server#createuploadthing
+ */
 import { createUploadthing, type FileRouter } from "uploadthing/server";
 
 const f = createUploadthing({