diff --git a/packages/fetch-router/README.md b/packages/fetch-router/README.md index 98a8198f14a..5fd6b946988 100644 --- a/packages/fetch-router/README.md +++ b/packages/fetch-router/README.md @@ -174,7 +174,7 @@ router.map(routes, { ### Resource-based Routes -Create resource-based route maps with the `resource` and `resources` functions. This can help DRY up your route definitions when creating RESTful APIs, Rails-style routes, etc. +Create resource-based route maps with the `resource` and `resources` functions. This can help DRY up your route definitions when creating RESTful APIs, Rails-style routes, etc. This example illustrates [Rails-style routes](https://guides.rubyonrails.org/routing.html#resource-routing-the-rails-default): ```ts import { resource, resources, createRoutes } from '@remix-run/fetch-router' @@ -511,8 +511,7 @@ router.map(routes, { `) }, - async create({ request }) { - let formData = await request.formData() + async create({ formData, request }) { let post = await db.createPost({ title: formData.get('title'), content: formData.get('content'), @@ -553,8 +552,7 @@ router.map(routes, { `) }, - async update({ params, request }) { - let formData = await request.formData() + async update({ formData, params, request }) { await db.updatePost(params.slug, { title: formData.get('title'), content: formData.get('content'), @@ -569,8 +567,16 @@ router.map(routes, { }) export { router } + +// Use the router in server environments that deal in request/response objects, e.g. +// +// ``` +// import { router } from "./router" +// export default async function handler(req: Request) { return router.fetch(req) } +// ``` ``` + ## Related Work - [@remix-run/route-pattern](../route-pattern) - The pattern matching library that powers `fetch-router`