gatsby-plugin-cloudflare-functions

Run your Cloudflare Pages Functions locally when running gatsby develop.

Install

``shell
npm install gatsby-plugin-cloudflare-functions
`

How to use

Add the plugin to your gatsby-config.js.

`javascript
module.exports = {
plugins: ['gatsby-plugin-cloudflare-functions'],
}
`

The plugin uses wrangler to run your functions which
automatically pick configuration from a wrangler.toml or wrangler.json file and
variables/secrets from a .dev.vars file.
It is recommended to add .wrangler/ to your .gitignore file to avoid committing the temporary
files that wrangler creates.

if you don't use a wrangler.toml file to configure Cloudflare Pages you can also configure the
plugin via plugin options. Bindings defined here take precedence over those in a wrangler.toml
file.

See the example below which includes all available plugin options.

`javascript
module.exports = {
plugins: [
{
resolve: 'gatsby-plugin-cloudflare-functions',
options: {
compatibilityDate: '2024-11-15',
compatibilityFlag: ['nodejs_als'],
binding: {
MY_VAR: process.env.MY_VAR,
MY_SECRET: process.env.MY_SECRET,
},
kv: ['MY_KV_NAMESPACE'],
r2: ['MY_R2_BUCKET'],
d1: ['MY_D1_DATABASE'],
do: ['MY_DURABLE_OBJECT'],
ai: 'MY_AI',
},
},
],
}
`

Options

$3

Runtime compatibility date to apply.
See

$3

Runtime compatibility flags to apply.
See

$3

Bind environment variables or secrets.
Alternatively these can be specified in a file called .dev.vars` in dotenv format.

$3

Binding name of KV namespace to bind.

$3

Binding name of R2 bucket to bind.

$3

Binding name of D1 database to bind.

$3

Binding name of Durable Object to bind.

$3

Binding name of Workers AI to bind.