跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

WranglerConfig

最后更新 查看 MarkdownAgent 设置

The WranglerConfig component is used 711 times on 401 pages.

See all examples of pages that use WranglerConfig

Used 711 times.

Pages

Partials

该组件可用于自动生成 Cloudflare Wrangler 配置文件的 toml 文件的 jsonc 版本(反之亦然)。

导入

import { WranglerConfig } from "~/components";

用法

import { WranglerConfig } from "~/components";

<WranglerConfig>
```toml
[[d1_databases]]
binding = "DB" # available in your Worker on env.DB
database_name = "prod-d1-tutorial"
database_id = "<unique-ID-for-your-database>"
```
</WranglerConfig>

Cloudflare CLI 配置

使用 cfConfig 提供经过审核的等效 cloudflare.config.ts 配置。提供此属性会显示共享的 CLI 选择器。

import { WranglerConfig } from "~/components";

<WranglerConfig
	cfConfig={`export default {
	name: "my-worker",
};`}
>
```jsonc
{
	"name": "my-worker"
}
```
</WranglerConfig>

兼容性日期

对于新项目,您通常应该对 compatibility_date 值使用 $today。这个魔法字符串在构建时会自动替换为当前日期,确保文档始终建议最新的日期。当使用 $today 时,该组件还会在 compatibility_date 行上方自动注入注释(例如,TOML 中的 # Set this to today's date 和 JSONC 中的 // Set this to today's date),以便读者知道要保持该值最新。如果您需要指定固定日期,也可以这样做,但您可能会错过最新的功能和性能改进。您可以使用兼容性标志(compatibility flags)来禁用特定功能。

import { WranglerConfig } from "~/components";

<WranglerConfig>
```jsonc
{
	"name": "my-worker",
	"compatibility_date": "$today"
}
```
</WranglerConfig>

最低兼容性日期

某些功能需要最低兼容性日期。在记录这些功能时,请使用 :::note 组件在文档页面上清晰地传达该要求:

:::note
This feature requires a `compatibility_date` of `2024-09-23` or later.
:::

removeSchema prop 可用于从生成的 JSON 文件中移除 $schema 引用。如果您想添加更易于复制粘贴的配置文件片段,并且将 toml 作为源配置格式,这将非常有用。

如果您提供 jsonc 作为源配置格式,removeSchema prop 将被忽略。

import { WranglerConfig } from "~/components";

<WranglerConfig removeSchema>
```toml
[[d1_databases]]
binding = "DB" # available in your Worker on env.DB
database_name = "prod-d1-tutorial"
database_id = "<unique-ID-for-your-database>"
```
</WranglerConfig>

这篇文档对您有帮助吗?