Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(guides/data-loading): add Cloudflare Pages reference to Cloudflare KV section #3718

Merged
merged 8 commits into from
Jul 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions contributors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,7 @@
- vkrol
- vlindhol
- vmosyaykin
- vorcigernix
- weavdale
- wKovacs64
- wladiston
Expand Down
36 changes: 28 additions & 8 deletions docs/guides/data-loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,19 +229,23 @@ export default function Product() {
```

## Cloudflare KV
If you picked Cloudflare Pages as your environment, [Cloudflare Key Value][cloudflare-kv] storage allows you to persist data at the edge as if it were a static resource. To start with local development, you need to add a `--kv` parameter with a name of your namespace to the package.json task, so it would look like this:

If you picked Cloudflare Workers as your environment, [Cloudflare Key Value][cloudflare-kv] storage allows you to persist data at the edge as if it were a static resource. You'll need to [do some configuration][cloudflare-kv-setup] but then you can access the data from your loaders:
```
"dev:wrangler": "cross-env NODE_ENV=development wrangler pages dev ./public --kv PRODUCTS_KV"
```

```tsx filename=app/routes/products/$productId.tsx
import type { LoaderFunction } from "@remix-run/node"; // or "@remix-run/cloudflare"
import { json } from "@remix-run/node"; // or "@remix-run/cloudflare"
This enables you to use the `PRODUCTS_KV` in a loader context (KV stores are added to loader context automatically by the Cloudflare Pages adapter):
```tsx
import type { LoaderFunction } from "@remix-run/cloudflare"; // or "@remix-run/node"
import { json } from "@remix-run/cloudflare"; // or "@remix-run/node"
import { useLoaderData } from "@remix-run/react";

export const loader: LoaderFunction = async ({
params,
context, params,
}) => {
return json(
await PRODUCTS_KV.get(`product-${params.productId}`, {
await context.PRODUCTS_KV.get(`product-${params.productId}`, {
type: "json",
})
);
Expand All @@ -251,13 +255,29 @@ export default function Product() {
const product = useLoaderData();
return (
<div>
<p>{} Products</p>
{/* ... */}
<p>Product</p>
{product.name}
</div>
);
}
```



For Cloudflare Workers environment you'll need to [do some configuration][cloudflare-kv-setup] but then you can access the data from your loaders. You also don't use context to access namespace, so the loader function would look like this:

```tsx filename=app/routes/products/$productId.tsx
export const loader: LoaderFunction = async ({
params,
}) => {
return json(
await PRODUCTS_KV.get(`product-${params.productId}`, {
type: "json",
})
);
};
```

## Not Found

While loading data it's common for a record to be "not found". As soon as you know you can't render the component as expected, `throw` a response and Remix will stop executing code in the current loader and switch over to the nearest [catch boundary][catch-boundary].
Expand Down