wrangler 0.0.0-e4fe35cc5 → 0.0.0-e51304ca0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -41
- package/bin/wrangler.js +2 -8
- package/config-schema.json +417 -1242
- package/package.json +39 -54
- package/templates/init-tests/test-vitest-new-worker.ts +2 -2
- package/templates/middleware/middleware-patch-console-prefix.d.ts +3 -0
- package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
- package/templates/pages-dev-pipeline.ts +3 -2
- package/templates/tsconfig.json +8 -1
- package/templates/tsconfig.tsbuildinfo +1 -0
- package/wrangler-dist/InspectorProxyWorker.js +4 -8
- package/wrangler-dist/InspectorProxyWorker.js.map +1 -1
- package/wrangler-dist/ProxyWorker.js +3 -6
- package/wrangler-dist/ProxyWorker.js.map +1 -1
- package/wrangler-dist/cli.d.ts +649 -421
- package/wrangler-dist/cli.js +124450 -188831
- package/templates/middleware/middleware-serve-static-assets.d.ts +0 -6
- package/templates/middleware/middleware-serve-static-assets.ts +0 -56
- package/wrangler-dist/wasm-sync.wasm +0 -0
package/config-schema.json
CHANGED
|
@@ -2,6 +2,43 @@
|
|
|
2
2
|
"$ref": "#/definitions/RawConfig",
|
|
3
3
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
4
4
|
"definitions": {
|
|
5
|
+
"Assets": {
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"properties": {
|
|
8
|
+
"binding": {
|
|
9
|
+
"description": "Name of `env` binding property in the User Worker.",
|
|
10
|
+
"type": "string"
|
|
11
|
+
},
|
|
12
|
+
"directory": {
|
|
13
|
+
"description": "Absolute path to assets directory",
|
|
14
|
+
"type": "string"
|
|
15
|
+
},
|
|
16
|
+
"html_handling": {
|
|
17
|
+
"description": "How to handle HTML requests.",
|
|
18
|
+
"enum": [
|
|
19
|
+
"auto-trailing-slash",
|
|
20
|
+
"force-trailing-slash",
|
|
21
|
+
"drop-trailing-slash",
|
|
22
|
+
"none"
|
|
23
|
+
],
|
|
24
|
+
"type": "string"
|
|
25
|
+
},
|
|
26
|
+
"not_found_handling": {
|
|
27
|
+
"description": "How to handle requests that do not match an asset.",
|
|
28
|
+
"enum": [
|
|
29
|
+
"single-page-application",
|
|
30
|
+
"404-page",
|
|
31
|
+
"none"
|
|
32
|
+
],
|
|
33
|
+
"type": "string"
|
|
34
|
+
},
|
|
35
|
+
"run_worker_first": {
|
|
36
|
+
"description": "If true, route every request to the User Worker, whether or not it matches an asset. If false, then respond to requests that match an asset with that asset directly.",
|
|
37
|
+
"type": "boolean"
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"type": "object"
|
|
41
|
+
},
|
|
5
42
|
"CloudchamberConfig": {
|
|
6
43
|
"additionalProperties": false,
|
|
7
44
|
"description": "Configuration in wrangler for Cloudchamber",
|
|
@@ -38,50 +75,121 @@
|
|
|
38
75
|
],
|
|
39
76
|
"type": "string"
|
|
40
77
|
},
|
|
41
|
-
"
|
|
78
|
+
"ContainerApp": {
|
|
42
79
|
"additionalProperties": false,
|
|
80
|
+
"description": "Configuration for a container application",
|
|
43
81
|
"properties": {
|
|
44
|
-
"
|
|
45
|
-
"
|
|
82
|
+
"configuration": {
|
|
83
|
+
"additionalProperties": false,
|
|
84
|
+
"properties": {
|
|
85
|
+
"image": {
|
|
86
|
+
"type": "string"
|
|
87
|
+
},
|
|
88
|
+
"labels": {
|
|
89
|
+
"items": {
|
|
90
|
+
"additionalProperties": false,
|
|
91
|
+
"properties": {
|
|
92
|
+
"name": {
|
|
93
|
+
"type": "string"
|
|
94
|
+
},
|
|
95
|
+
"value": {
|
|
96
|
+
"type": "string"
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
"required": [
|
|
100
|
+
"name",
|
|
101
|
+
"value"
|
|
102
|
+
],
|
|
103
|
+
"type": "object"
|
|
104
|
+
},
|
|
105
|
+
"type": "array"
|
|
106
|
+
},
|
|
107
|
+
"secrets": {
|
|
108
|
+
"items": {
|
|
109
|
+
"additionalProperties": false,
|
|
110
|
+
"properties": {
|
|
111
|
+
"name": {
|
|
112
|
+
"type": "string"
|
|
113
|
+
},
|
|
114
|
+
"secret": {
|
|
115
|
+
"type": "string"
|
|
116
|
+
},
|
|
117
|
+
"type": {
|
|
118
|
+
"const": "env",
|
|
119
|
+
"type": "string"
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
"required": [
|
|
123
|
+
"name",
|
|
124
|
+
"type",
|
|
125
|
+
"secret"
|
|
126
|
+
],
|
|
127
|
+
"type": "object"
|
|
128
|
+
},
|
|
129
|
+
"type": "array"
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"required": [
|
|
133
|
+
"image"
|
|
134
|
+
],
|
|
135
|
+
"type": "object"
|
|
46
136
|
},
|
|
47
|
-
"
|
|
137
|
+
"constraints": {
|
|
138
|
+
"additionalProperties": false,
|
|
139
|
+
"properties": {
|
|
140
|
+
"cities": {
|
|
141
|
+
"items": {
|
|
142
|
+
"type": "string"
|
|
143
|
+
},
|
|
144
|
+
"type": "array"
|
|
145
|
+
},
|
|
146
|
+
"regions": {
|
|
147
|
+
"items": {
|
|
148
|
+
"type": "string"
|
|
149
|
+
},
|
|
150
|
+
"type": "array"
|
|
151
|
+
},
|
|
152
|
+
"tier": {
|
|
153
|
+
"type": "number"
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"type": "object"
|
|
157
|
+
},
|
|
158
|
+
"instances": {
|
|
159
|
+
"type": "number"
|
|
160
|
+
},
|
|
161
|
+
"name": {
|
|
162
|
+
"type": "string"
|
|
163
|
+
},
|
|
164
|
+
"scheduling_policy": {
|
|
165
|
+
"enum": [
|
|
166
|
+
"regional",
|
|
167
|
+
"moon"
|
|
168
|
+
],
|
|
48
169
|
"type": "string"
|
|
49
170
|
}
|
|
50
171
|
},
|
|
51
172
|
"required": [
|
|
52
|
-
"
|
|
53
|
-
"
|
|
173
|
+
"name",
|
|
174
|
+
"instances",
|
|
175
|
+
"configuration"
|
|
54
176
|
],
|
|
55
177
|
"type": "object"
|
|
56
178
|
},
|
|
57
|
-
"
|
|
179
|
+
"CustomDomainRoute": {
|
|
58
180
|
"additionalProperties": false,
|
|
59
|
-
"description": "Deprecated upload configuration.",
|
|
60
181
|
"properties": {
|
|
61
|
-
"
|
|
62
|
-
"
|
|
63
|
-
"description": "The directory you wish to upload your Worker from, relative to the wrangler.toml file.\n\nDefaults to the directory containing the wrangler.toml file.",
|
|
64
|
-
"type": "string"
|
|
65
|
-
},
|
|
66
|
-
"format": {
|
|
67
|
-
"deprecated": "We infer the format automatically now.",
|
|
68
|
-
"description": "The format of the Worker script.",
|
|
69
|
-
"enum": [
|
|
70
|
-
"modules",
|
|
71
|
-
"service-worker"
|
|
72
|
-
],
|
|
73
|
-
"type": "string"
|
|
182
|
+
"custom_domain": {
|
|
183
|
+
"type": "boolean"
|
|
74
184
|
},
|
|
75
|
-
"
|
|
76
|
-
"deprecated": "This will be replaced by a command line argument.",
|
|
77
|
-
"description": "The path to the Worker script, relative to `upload.dir`.",
|
|
185
|
+
"pattern": {
|
|
78
186
|
"type": "string"
|
|
79
|
-
},
|
|
80
|
-
"rules": {
|
|
81
|
-
"$ref": "#/definitions/Environment",
|
|
82
|
-
"deprecated": "This is now defined at the top level `rules` field."
|
|
83
187
|
}
|
|
84
188
|
},
|
|
189
|
+
"required": [
|
|
190
|
+
"pattern",
|
|
191
|
+
"custom_domain"
|
|
192
|
+
],
|
|
85
193
|
"type": "object"
|
|
86
194
|
},
|
|
87
195
|
"DispatchNamespaceOutbound": {
|
|
@@ -192,17 +300,72 @@
|
|
|
192
300
|
],
|
|
193
301
|
"type": "object"
|
|
194
302
|
},
|
|
195
|
-
"
|
|
303
|
+
"Json": {
|
|
304
|
+
"anyOf": [
|
|
305
|
+
{
|
|
306
|
+
"$ref": "#/definitions/Literal"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"additionalProperties": {
|
|
310
|
+
"$ref": "#/definitions/Json"
|
|
311
|
+
},
|
|
312
|
+
"type": "object"
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"items": {
|
|
316
|
+
"$ref": "#/definitions/Json"
|
|
317
|
+
},
|
|
318
|
+
"type": "array"
|
|
319
|
+
}
|
|
320
|
+
]
|
|
321
|
+
},
|
|
322
|
+
"Literal": {
|
|
323
|
+
"$ref": "#/definitions/TypeOf%3CZodUnion%3C%5Bdef-class-1315922706-6501-8772-1315922706-0-54395%2Cdef-class-1315922706-9299-10989-1315922706-0-54395%2Cdef-class-1315922706-12937-13365-1315922706-0-54395%2Cdef-class-1315922706-15083-15273-1315922706-0-54395%5D%3E%3E"
|
|
324
|
+
},
|
|
325
|
+
"Observability": {
|
|
326
|
+
"additionalProperties": false,
|
|
327
|
+
"properties": {
|
|
328
|
+
"enabled": {
|
|
329
|
+
"description": "If observability is enabled for this Worker",
|
|
330
|
+
"type": "boolean"
|
|
331
|
+
},
|
|
332
|
+
"head_sampling_rate": {
|
|
333
|
+
"description": "The sampling rate",
|
|
334
|
+
"type": "number"
|
|
335
|
+
},
|
|
336
|
+
"logs": {
|
|
337
|
+
"additionalProperties": false,
|
|
338
|
+
"properties": {
|
|
339
|
+
"enabled": {
|
|
340
|
+
"type": "boolean"
|
|
341
|
+
},
|
|
342
|
+
"head_sampling_rate": {
|
|
343
|
+
"description": "The sampling rate",
|
|
344
|
+
"type": "number"
|
|
345
|
+
},
|
|
346
|
+
"invocation_logs": {
|
|
347
|
+
"description": "Set to false to disable invocation logs",
|
|
348
|
+
"type": "boolean"
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
"type": "object"
|
|
352
|
+
}
|
|
353
|
+
},
|
|
354
|
+
"type": "object"
|
|
355
|
+
},
|
|
356
|
+
"RawConfig": {
|
|
196
357
|
"additionalProperties": false,
|
|
197
|
-
"description": "The `Environment` interface declares all the configuration fields that can be specified for an environment.\n\nThis could be the top-level default environment, or a specific named environment.",
|
|
198
358
|
"properties": {
|
|
359
|
+
"$schema": {
|
|
360
|
+
"type": "string"
|
|
361
|
+
},
|
|
199
362
|
"account_id": {
|
|
200
363
|
"description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
|
|
201
364
|
"type": "string"
|
|
202
365
|
},
|
|
203
366
|
"ai": {
|
|
204
367
|
"additionalProperties": false,
|
|
205
|
-
"default":
|
|
368
|
+
"default": {},
|
|
206
369
|
"description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
207
370
|
"properties": {
|
|
208
371
|
"binding": {
|
|
@@ -217,973 +380,38 @@
|
|
|
217
380
|
],
|
|
218
381
|
"type": "object"
|
|
219
382
|
},
|
|
383
|
+
"alias": {
|
|
384
|
+
"additionalProperties": {
|
|
385
|
+
"type": "string"
|
|
386
|
+
},
|
|
387
|
+
"description": "A map of module aliases. Lets you swap out a module for any others. Corresponds with esbuild's `alias` config",
|
|
388
|
+
"type": "object"
|
|
389
|
+
},
|
|
220
390
|
"analytics_engine_datasets": {
|
|
221
|
-
"default":
|
|
391
|
+
"default": [],
|
|
222
392
|
"description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
223
393
|
"items": {
|
|
224
394
|
"additionalProperties": false,
|
|
225
395
|
"properties": {
|
|
226
396
|
"binding": {
|
|
227
397
|
"description": "The binding name used to refer to the dataset in the Worker.",
|
|
228
|
-
"type": "string"
|
|
229
|
-
},
|
|
230
|
-
"dataset": {
|
|
231
|
-
"description": "The name of this dataset to write to.",
|
|
232
|
-
"type": "string"
|
|
233
|
-
}
|
|
234
|
-
},
|
|
235
|
-
"required": [
|
|
236
|
-
"binding"
|
|
237
|
-
],
|
|
238
|
-
"type": "object"
|
|
239
|
-
},
|
|
240
|
-
"type": "array"
|
|
241
|
-
},
|
|
242
|
-
"base_dir": {
|
|
243
|
-
"description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
|
|
244
|
-
"type": "string"
|
|
245
|
-
},
|
|
246
|
-
"browser": {
|
|
247
|
-
"additionalProperties": false,
|
|
248
|
-
"default": "`{}`",
|
|
249
|
-
"description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
250
|
-
"properties": {
|
|
251
|
-
"binding": {
|
|
252
|
-
"type": "string"
|
|
253
|
-
}
|
|
254
|
-
},
|
|
255
|
-
"required": [
|
|
256
|
-
"binding"
|
|
257
|
-
],
|
|
258
|
-
"type": "object"
|
|
259
|
-
},
|
|
260
|
-
"build": {
|
|
261
|
-
"additionalProperties": false,
|
|
262
|
-
"default": {
|
|
263
|
-
"watch_dir": "./src"
|
|
264
|
-
},
|
|
265
|
-
"description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
|
|
266
|
-
"properties": {
|
|
267
|
-
"command": {
|
|
268
|
-
"description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used.",
|
|
269
|
-
"type": "string"
|
|
270
|
-
},
|
|
271
|
-
"cwd": {
|
|
272
|
-
"description": "The directory in which the command is executed.",
|
|
273
|
-
"type": "string"
|
|
274
|
-
},
|
|
275
|
-
"upload": {
|
|
276
|
-
"$ref": "#/definitions/DeprecatedUpload",
|
|
277
|
-
"deprecated": true,
|
|
278
|
-
"description": "Deprecated field previously used to configure the build and upload of the script."
|
|
279
|
-
},
|
|
280
|
-
"watch_dir": {
|
|
281
|
-
"anyOf": [
|
|
282
|
-
{
|
|
283
|
-
"type": "string"
|
|
284
|
-
},
|
|
285
|
-
{
|
|
286
|
-
"items": {
|
|
287
|
-
"type": "string"
|
|
288
|
-
},
|
|
289
|
-
"type": "array"
|
|
290
|
-
}
|
|
291
|
-
],
|
|
292
|
-
"description": "The directory to watch for changes while using wrangler dev, defaults to the current working directory"
|
|
293
|
-
}
|
|
294
|
-
},
|
|
295
|
-
"type": "object"
|
|
296
|
-
},
|
|
297
|
-
"cloudchamber": {
|
|
298
|
-
"$ref": "#/definitions/CloudchamberConfig",
|
|
299
|
-
"default": "`{}`",
|
|
300
|
-
"description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
|
|
301
|
-
},
|
|
302
|
-
"compatibility_date": {
|
|
303
|
-
"description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
|
304
|
-
"type": "string"
|
|
305
|
-
},
|
|
306
|
-
"compatibility_flags": {
|
|
307
|
-
"default": "`[]`",
|
|
308
|
-
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_flags.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
|
309
|
-
"items": {
|
|
310
|
-
"type": "string"
|
|
311
|
-
},
|
|
312
|
-
"type": "array"
|
|
313
|
-
},
|
|
314
|
-
"d1_databases": {
|
|
315
|
-
"default": "`[]`",
|
|
316
|
-
"description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
317
|
-
"items": {
|
|
318
|
-
"additionalProperties": false,
|
|
319
|
-
"properties": {
|
|
320
|
-
"binding": {
|
|
321
|
-
"description": "The binding name used to refer to the D1 database in the Worker.",
|
|
322
|
-
"type": "string"
|
|
323
|
-
},
|
|
324
|
-
"database_id": {
|
|
325
|
-
"description": "The UUID of this D1 database (not required).",
|
|
326
|
-
"type": "string"
|
|
327
|
-
},
|
|
328
|
-
"database_internal_env": {
|
|
329
|
-
"description": "Internal use only.",
|
|
330
|
-
"type": "string"
|
|
331
|
-
},
|
|
332
|
-
"database_name": {
|
|
333
|
-
"description": "The name of this D1 database.",
|
|
334
|
-
"type": "string"
|
|
335
|
-
},
|
|
336
|
-
"migrations_dir": {
|
|
337
|
-
"description": "The path to the directory of migrations for this D1 database (defaults to './migrations').",
|
|
338
|
-
"type": "string"
|
|
339
|
-
},
|
|
340
|
-
"migrations_table": {
|
|
341
|
-
"description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations').",
|
|
342
|
-
"type": "string"
|
|
343
|
-
},
|
|
344
|
-
"preview_database_id": {
|
|
345
|
-
"description": "The UUID of this D1 database for Wrangler Dev (if specified).",
|
|
346
|
-
"type": "string"
|
|
347
|
-
}
|
|
348
|
-
},
|
|
349
|
-
"required": [
|
|
350
|
-
"binding",
|
|
351
|
-
"database_name",
|
|
352
|
-
"database_id"
|
|
353
|
-
],
|
|
354
|
-
"type": "object"
|
|
355
|
-
},
|
|
356
|
-
"type": "array"
|
|
357
|
-
},
|
|
358
|
-
"define": {
|
|
359
|
-
"additionalProperties": {
|
|
360
|
-
"type": "string"
|
|
361
|
-
},
|
|
362
|
-
"default": "`{}`",
|
|
363
|
-
"description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
364
|
-
"type": "object"
|
|
365
|
-
},
|
|
366
|
-
"dispatch_namespaces": {
|
|
367
|
-
"default": "`[]`",
|
|
368
|
-
"description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
369
|
-
"items": {
|
|
370
|
-
"additionalProperties": false,
|
|
371
|
-
"properties": {
|
|
372
|
-
"binding": {
|
|
373
|
-
"description": "The binding name used to refer to the bound service.",
|
|
374
|
-
"type": "string"
|
|
375
|
-
},
|
|
376
|
-
"namespace": {
|
|
377
|
-
"description": "The namespace to bind to.",
|
|
378
|
-
"type": "string"
|
|
379
|
-
},
|
|
380
|
-
"outbound": {
|
|
381
|
-
"$ref": "#/definitions/DispatchNamespaceOutbound",
|
|
382
|
-
"description": "Details about the outbound Worker which will handle outbound requests from your namespace"
|
|
383
|
-
}
|
|
384
|
-
},
|
|
385
|
-
"required": [
|
|
386
|
-
"binding",
|
|
387
|
-
"namespace"
|
|
388
|
-
],
|
|
389
|
-
"type": "object"
|
|
390
|
-
},
|
|
391
|
-
"type": "array"
|
|
392
|
-
},
|
|
393
|
-
"durable_objects": {
|
|
394
|
-
"additionalProperties": false,
|
|
395
|
-
"default": "`{bindings:[]}`",
|
|
396
|
-
"description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
397
|
-
"properties": {
|
|
398
|
-
"bindings": {
|
|
399
|
-
"$ref": "#/definitions/DurableObjectBindings"
|
|
400
|
-
}
|
|
401
|
-
},
|
|
402
|
-
"required": [
|
|
403
|
-
"bindings"
|
|
404
|
-
],
|
|
405
|
-
"type": "object"
|
|
406
|
-
},
|
|
407
|
-
"experimental_assets": {
|
|
408
|
-
"$ref": "#/definitions/ExperimentalAssets",
|
|
409
|
-
"description": "Specify the directory of static assets to deploy/serve"
|
|
410
|
-
},
|
|
411
|
-
"find_additional_modules": {
|
|
412
|
-
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
|
|
413
|
-
"type": "boolean"
|
|
414
|
-
},
|
|
415
|
-
"first_party_worker": {
|
|
416
|
-
"description": "Designates this Worker as an internal-only \"first-party\" Worker.",
|
|
417
|
-
"type": "boolean"
|
|
418
|
-
},
|
|
419
|
-
"hyperdrive": {
|
|
420
|
-
"default": "`[]`",
|
|
421
|
-
"description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
422
|
-
"items": {
|
|
423
|
-
"additionalProperties": false,
|
|
424
|
-
"properties": {
|
|
425
|
-
"binding": {
|
|
426
|
-
"description": "The binding name used to refer to the project in the Worker.",
|
|
427
|
-
"type": "string"
|
|
428
|
-
},
|
|
429
|
-
"id": {
|
|
430
|
-
"description": "The id of the database.",
|
|
431
|
-
"type": "string"
|
|
432
|
-
},
|
|
433
|
-
"localConnectionString": {
|
|
434
|
-
"description": "The local database connection string for `wrangler dev`",
|
|
435
|
-
"type": "string"
|
|
436
|
-
}
|
|
437
|
-
},
|
|
438
|
-
"required": [
|
|
439
|
-
"binding",
|
|
440
|
-
"id"
|
|
441
|
-
],
|
|
442
|
-
"type": "object"
|
|
443
|
-
},
|
|
444
|
-
"type": "array"
|
|
445
|
-
},
|
|
446
|
-
"jsx_factory": {
|
|
447
|
-
"default": "`\"React.createElement\"`",
|
|
448
|
-
"description": "The function to use to replace jsx syntax.",
|
|
449
|
-
"type": "string"
|
|
450
|
-
},
|
|
451
|
-
"jsx_fragment": {
|
|
452
|
-
"default": "`\"React.Fragment\"`",
|
|
453
|
-
"description": "The function to use to replace jsx fragment syntax.",
|
|
454
|
-
"type": "string"
|
|
455
|
-
},
|
|
456
|
-
"kv_namespaces": {
|
|
457
|
-
"default": "`[]`",
|
|
458
|
-
"description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
459
|
-
"items": {
|
|
460
|
-
"additionalProperties": false,
|
|
461
|
-
"properties": {
|
|
462
|
-
"binding": {
|
|
463
|
-
"description": "The binding name used to refer to the KV Namespace",
|
|
464
|
-
"type": "string"
|
|
465
|
-
},
|
|
466
|
-
"id": {
|
|
467
|
-
"description": "The ID of the KV namespace",
|
|
468
|
-
"type": "string"
|
|
469
|
-
},
|
|
470
|
-
"preview_id": {
|
|
471
|
-
"description": "The ID of the KV namespace used during `wrangler dev`",
|
|
472
|
-
"type": "string"
|
|
473
|
-
}
|
|
474
|
-
},
|
|
475
|
-
"required": [
|
|
476
|
-
"binding",
|
|
477
|
-
"id"
|
|
478
|
-
],
|
|
479
|
-
"type": "object"
|
|
480
|
-
},
|
|
481
|
-
"type": "array"
|
|
482
|
-
},
|
|
483
|
-
"limits": {
|
|
484
|
-
"$ref": "#/definitions/UserLimits",
|
|
485
|
-
"description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
|
|
486
|
-
},
|
|
487
|
-
"logfwdr": {
|
|
488
|
-
"additionalProperties": false,
|
|
489
|
-
"default": "`{bindings:[]}`",
|
|
490
|
-
"description": "List of bindings that you will send to logfwdr",
|
|
491
|
-
"properties": {
|
|
492
|
-
"bindings": {
|
|
493
|
-
"items": {
|
|
494
|
-
"additionalProperties": false,
|
|
495
|
-
"properties": {
|
|
496
|
-
"destination": {
|
|
497
|
-
"description": "The destination for this logged message",
|
|
498
|
-
"type": "string"
|
|
499
|
-
},
|
|
500
|
-
"name": {
|
|
501
|
-
"description": "The binding name used to refer to logfwdr",
|
|
502
|
-
"type": "string"
|
|
503
|
-
}
|
|
504
|
-
},
|
|
505
|
-
"required": [
|
|
506
|
-
"name",
|
|
507
|
-
"destination"
|
|
508
|
-
],
|
|
509
|
-
"type": "object"
|
|
510
|
-
},
|
|
511
|
-
"type": "array"
|
|
512
|
-
}
|
|
513
|
-
},
|
|
514
|
-
"required": [
|
|
515
|
-
"bindings"
|
|
516
|
-
],
|
|
517
|
-
"type": "object"
|
|
518
|
-
},
|
|
519
|
-
"logpush": {
|
|
520
|
-
"description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/",
|
|
521
|
-
"type": "boolean"
|
|
522
|
-
},
|
|
523
|
-
"main": {
|
|
524
|
-
"description": "The entrypoint/path to the JavaScript file that will be executed.",
|
|
525
|
-
"type": "string"
|
|
526
|
-
},
|
|
527
|
-
"migrations": {
|
|
528
|
-
"default": [],
|
|
529
|
-
"description": "A list of migrations that should be uploaded with your Worker.\n\nThese define changes in your Durable Object declarations.\n\nMore details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations",
|
|
530
|
-
"items": {
|
|
531
|
-
"$ref": "#/definitions/DurableObjectMigration"
|
|
532
|
-
},
|
|
533
|
-
"type": "array"
|
|
534
|
-
},
|
|
535
|
-
"minify": {
|
|
536
|
-
"description": "Minify the script before uploading.",
|
|
537
|
-
"type": "boolean"
|
|
538
|
-
},
|
|
539
|
-
"mtls_certificates": {
|
|
540
|
-
"default": "`[]`",
|
|
541
|
-
"description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
542
|
-
"items": {
|
|
543
|
-
"additionalProperties": false,
|
|
544
|
-
"properties": {
|
|
545
|
-
"binding": {
|
|
546
|
-
"description": "The binding name used to refer to the certificate in the Worker",
|
|
547
|
-
"type": "string"
|
|
548
|
-
},
|
|
549
|
-
"certificate_id": {
|
|
550
|
-
"description": "The uuid of the uploaded mTLS certificate",
|
|
551
|
-
"type": "string"
|
|
552
|
-
}
|
|
553
|
-
},
|
|
554
|
-
"required": [
|
|
555
|
-
"binding",
|
|
556
|
-
"certificate_id"
|
|
557
|
-
],
|
|
558
|
-
"type": "object"
|
|
559
|
-
},
|
|
560
|
-
"type": "array"
|
|
561
|
-
},
|
|
562
|
-
"name": {
|
|
563
|
-
"description": "The name of your Worker. Alphanumeric + dashes only.",
|
|
564
|
-
"type": "string"
|
|
565
|
-
},
|
|
566
|
-
"no_bundle": {
|
|
567
|
-
"description": "Skip internal build steps and directly deploy script",
|
|
568
|
-
"type": "boolean"
|
|
569
|
-
},
|
|
570
|
-
"node_compat": {
|
|
571
|
-
"description": "Add polyfills for node builtin modules and globals",
|
|
572
|
-
"type": "boolean"
|
|
573
|
-
},
|
|
574
|
-
"observability": {
|
|
575
|
-
"$ref": "#/definitions/Observability",
|
|
576
|
-
"description": "Specify the observability behavior of the Worker."
|
|
577
|
-
},
|
|
578
|
-
"pipelines": {
|
|
579
|
-
"default": "`[]`",
|
|
580
|
-
"description": "Specifies list of Pipelines bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
581
|
-
"items": {
|
|
582
|
-
"additionalProperties": false,
|
|
583
|
-
"properties": {
|
|
584
|
-
"binding": {
|
|
585
|
-
"description": "The binding name used to refer to the bound service.",
|
|
586
|
-
"type": "string"
|
|
587
|
-
},
|
|
588
|
-
"pipeline": {
|
|
589
|
-
"description": "Name of the Pipeline to bind",
|
|
590
|
-
"type": "string"
|
|
591
|
-
}
|
|
592
|
-
},
|
|
593
|
-
"required": [
|
|
594
|
-
"binding",
|
|
595
|
-
"pipeline"
|
|
596
|
-
],
|
|
597
|
-
"type": "object"
|
|
598
|
-
},
|
|
599
|
-
"type": "array"
|
|
600
|
-
},
|
|
601
|
-
"placement": {
|
|
602
|
-
"additionalProperties": false,
|
|
603
|
-
"description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
|
|
604
|
-
"properties": {
|
|
605
|
-
"hint": {
|
|
606
|
-
"type": "string"
|
|
607
|
-
},
|
|
608
|
-
"mode": {
|
|
609
|
-
"enum": [
|
|
610
|
-
"off",
|
|
611
|
-
"smart"
|
|
612
|
-
],
|
|
613
|
-
"type": "string"
|
|
614
|
-
}
|
|
615
|
-
},
|
|
616
|
-
"required": [
|
|
617
|
-
"mode"
|
|
618
|
-
],
|
|
619
|
-
"type": "object"
|
|
620
|
-
},
|
|
621
|
-
"preserve_file_names": {
|
|
622
|
-
"description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
|
|
623
|
-
"type": "boolean"
|
|
624
|
-
},
|
|
625
|
-
"queues": {
|
|
626
|
-
"additionalProperties": false,
|
|
627
|
-
"default": "`{consumers:[],producers:[]}`",
|
|
628
|
-
"description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
629
|
-
"properties": {
|
|
630
|
-
"consumers": {
|
|
631
|
-
"description": "Consumer configuration",
|
|
632
|
-
"items": {
|
|
633
|
-
"additionalProperties": false,
|
|
634
|
-
"properties": {
|
|
635
|
-
"dead_letter_queue": {
|
|
636
|
-
"description": "The queue to send messages that failed to be consumed.",
|
|
637
|
-
"type": "string"
|
|
638
|
-
},
|
|
639
|
-
"max_batch_size": {
|
|
640
|
-
"description": "The maximum number of messages per batch",
|
|
641
|
-
"type": "number"
|
|
642
|
-
},
|
|
643
|
-
"max_batch_timeout": {
|
|
644
|
-
"description": "The maximum number of seconds to wait to fill a batch with messages.",
|
|
645
|
-
"type": "number"
|
|
646
|
-
},
|
|
647
|
-
"max_concurrency": {
|
|
648
|
-
"description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog.",
|
|
649
|
-
"type": [
|
|
650
|
-
"number",
|
|
651
|
-
"null"
|
|
652
|
-
]
|
|
653
|
-
},
|
|
654
|
-
"max_retries": {
|
|
655
|
-
"description": "The maximum number of retries for each message.",
|
|
656
|
-
"type": "number"
|
|
657
|
-
},
|
|
658
|
-
"queue": {
|
|
659
|
-
"description": "The name of the queue from which this consumer should consume.",
|
|
660
|
-
"type": "string"
|
|
661
|
-
},
|
|
662
|
-
"retry_delay": {
|
|
663
|
-
"description": "The number of seconds to wait before retrying a message",
|
|
664
|
-
"type": "number"
|
|
665
|
-
},
|
|
666
|
-
"type": {
|
|
667
|
-
"description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker.",
|
|
668
|
-
"type": "string"
|
|
669
|
-
},
|
|
670
|
-
"visibility_timeout_ms": {
|
|
671
|
-
"description": "The number of milliseconds to wait for pulled messages to become visible again",
|
|
672
|
-
"type": "number"
|
|
673
|
-
}
|
|
674
|
-
},
|
|
675
|
-
"required": [
|
|
676
|
-
"queue"
|
|
677
|
-
],
|
|
678
|
-
"type": "object"
|
|
679
|
-
},
|
|
680
|
-
"type": "array"
|
|
681
|
-
},
|
|
682
|
-
"producers": {
|
|
683
|
-
"description": "Producer bindings",
|
|
684
|
-
"items": {
|
|
685
|
-
"additionalProperties": false,
|
|
686
|
-
"properties": {
|
|
687
|
-
"binding": {
|
|
688
|
-
"description": "The binding name used to refer to the Queue in the Worker.",
|
|
689
|
-
"type": "string"
|
|
690
|
-
},
|
|
691
|
-
"delivery_delay": {
|
|
692
|
-
"description": "The number of seconds to wait before delivering a message",
|
|
693
|
-
"type": "number"
|
|
694
|
-
},
|
|
695
|
-
"queue": {
|
|
696
|
-
"description": "The name of this Queue.",
|
|
697
|
-
"type": "string"
|
|
698
|
-
}
|
|
699
|
-
},
|
|
700
|
-
"required": [
|
|
701
|
-
"binding",
|
|
702
|
-
"queue"
|
|
703
|
-
],
|
|
704
|
-
"type": "object"
|
|
705
|
-
},
|
|
706
|
-
"type": "array"
|
|
707
|
-
}
|
|
708
|
-
},
|
|
709
|
-
"type": "object"
|
|
710
|
-
},
|
|
711
|
-
"r2_buckets": {
|
|
712
|
-
"default": "`[]`",
|
|
713
|
-
"description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
714
|
-
"items": {
|
|
715
|
-
"additionalProperties": false,
|
|
716
|
-
"properties": {
|
|
717
|
-
"binding": {
|
|
718
|
-
"description": "The binding name used to refer to the R2 bucket in the Worker.",
|
|
719
|
-
"type": "string"
|
|
720
|
-
},
|
|
721
|
-
"bucket_name": {
|
|
722
|
-
"description": "The name of this R2 bucket at the edge.",
|
|
723
|
-
"type": "string"
|
|
724
|
-
},
|
|
725
|
-
"jurisdiction": {
|
|
726
|
-
"description": "The jurisdiction that the bucket exists in. Default if not present.",
|
|
727
|
-
"type": "string"
|
|
728
|
-
},
|
|
729
|
-
"preview_bucket_name": {
|
|
730
|
-
"description": "The preview name of this R2 bucket at the edge.",
|
|
731
|
-
"type": "string"
|
|
732
|
-
}
|
|
733
|
-
},
|
|
734
|
-
"required": [
|
|
735
|
-
"binding",
|
|
736
|
-
"bucket_name"
|
|
737
|
-
],
|
|
738
|
-
"type": "object"
|
|
739
|
-
},
|
|
740
|
-
"type": "array"
|
|
741
|
-
},
|
|
742
|
-
"route": {
|
|
743
|
-
"$ref": "#/definitions/Route",
|
|
744
|
-
"description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
|
|
745
|
-
},
|
|
746
|
-
"routes": {
|
|
747
|
-
"description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)",
|
|
748
|
-
"items": {
|
|
749
|
-
"$ref": "#/definitions/Route"
|
|
750
|
-
},
|
|
751
|
-
"type": "array"
|
|
752
|
-
},
|
|
753
|
-
"rules": {
|
|
754
|
-
"description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS.",
|
|
755
|
-
"items": {
|
|
756
|
-
"$ref": "#/definitions/Rule"
|
|
757
|
-
},
|
|
758
|
-
"type": "array"
|
|
759
|
-
},
|
|
760
|
-
"send_email": {
|
|
761
|
-
"default": "`[]`",
|
|
762
|
-
"description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
763
|
-
"items": {
|
|
764
|
-
"additionalProperties": false,
|
|
765
|
-
"properties": {
|
|
766
|
-
"allowed_destination_addresses": {
|
|
767
|
-
"description": "If this binding should be restricted to a set of verified addresses",
|
|
768
|
-
"items": {
|
|
769
|
-
"type": "string"
|
|
770
|
-
},
|
|
771
|
-
"type": "array"
|
|
772
|
-
},
|
|
773
|
-
"destination_address": {
|
|
774
|
-
"description": "If this binding should be restricted to a specific verified address",
|
|
775
|
-
"type": "string"
|
|
776
|
-
},
|
|
777
|
-
"name": {
|
|
778
|
-
"description": "The binding name used to refer to the this binding",
|
|
779
|
-
"type": "string"
|
|
780
|
-
}
|
|
781
|
-
},
|
|
782
|
-
"required": [
|
|
783
|
-
"name"
|
|
784
|
-
],
|
|
785
|
-
"type": "object"
|
|
786
|
-
},
|
|
787
|
-
"type": "array"
|
|
788
|
-
},
|
|
789
|
-
"services": {
|
|
790
|
-
"default": "`[]`",
|
|
791
|
-
"description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
792
|
-
"items": {
|
|
793
|
-
"additionalProperties": false,
|
|
794
|
-
"properties": {
|
|
795
|
-
"binding": {
|
|
796
|
-
"description": "The binding name used to refer to the bound service.",
|
|
797
|
-
"type": "string"
|
|
798
|
-
},
|
|
799
|
-
"entrypoint": {
|
|
800
|
-
"description": "Optionally, the entrypoint (named export) of the service to bind to.",
|
|
801
|
-
"type": "string"
|
|
802
|
-
},
|
|
803
|
-
"environment": {
|
|
804
|
-
"description": "The environment of the service (e.g. production, staging, etc).",
|
|
805
|
-
"type": "string"
|
|
806
|
-
},
|
|
807
|
-
"service": {
|
|
808
|
-
"description": "The name of the service.",
|
|
809
|
-
"type": "string"
|
|
810
|
-
}
|
|
811
|
-
},
|
|
812
|
-
"required": [
|
|
813
|
-
"binding",
|
|
814
|
-
"service"
|
|
815
|
-
],
|
|
816
|
-
"type": "object"
|
|
817
|
-
},
|
|
818
|
-
"type": "array"
|
|
819
|
-
},
|
|
820
|
-
"tail_consumers": {
|
|
821
|
-
"default": "`[]`",
|
|
822
|
-
"description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
823
|
-
"items": {
|
|
824
|
-
"$ref": "#/definitions/TailConsumer"
|
|
825
|
-
},
|
|
826
|
-
"type": "array"
|
|
827
|
-
},
|
|
828
|
-
"triggers": {
|
|
829
|
-
"additionalProperties": false,
|
|
830
|
-
"default": "`{crons:[]}`",
|
|
831
|
-
"description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
|
|
832
|
-
"properties": {
|
|
833
|
-
"crons": {
|
|
834
|
-
"items": {
|
|
835
|
-
"type": "string"
|
|
836
|
-
},
|
|
837
|
-
"type": "array"
|
|
838
|
-
}
|
|
839
|
-
},
|
|
840
|
-
"required": [
|
|
841
|
-
"crons"
|
|
842
|
-
],
|
|
843
|
-
"type": "object"
|
|
844
|
-
},
|
|
845
|
-
"tsconfig": {
|
|
846
|
-
"description": "Path to a custom tsconfig",
|
|
847
|
-
"type": "string"
|
|
848
|
-
},
|
|
849
|
-
"unsafe": {
|
|
850
|
-
"additionalProperties": false,
|
|
851
|
-
"default": "`{}`",
|
|
852
|
-
"description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
853
|
-
"properties": {
|
|
854
|
-
"bindings": {
|
|
855
|
-
"description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare.",
|
|
856
|
-
"items": {
|
|
857
|
-
"additionalProperties": {},
|
|
858
|
-
"properties": {
|
|
859
|
-
"name": {
|
|
860
|
-
"type": "string"
|
|
861
|
-
},
|
|
862
|
-
"type": {
|
|
863
|
-
"type": "string"
|
|
864
|
-
}
|
|
865
|
-
},
|
|
866
|
-
"required": [
|
|
867
|
-
"name",
|
|
868
|
-
"type"
|
|
869
|
-
],
|
|
870
|
-
"type": "object"
|
|
871
|
-
},
|
|
872
|
-
"type": "array"
|
|
873
|
-
},
|
|
874
|
-
"capnp": {
|
|
875
|
-
"anyOf": [
|
|
876
|
-
{
|
|
877
|
-
"additionalProperties": false,
|
|
878
|
-
"properties": {
|
|
879
|
-
"base_path": {
|
|
880
|
-
"type": "string"
|
|
881
|
-
},
|
|
882
|
-
"source_schemas": {
|
|
883
|
-
"items": {
|
|
884
|
-
"type": "string"
|
|
885
|
-
},
|
|
886
|
-
"type": "array"
|
|
887
|
-
}
|
|
888
|
-
},
|
|
889
|
-
"required": [
|
|
890
|
-
"base_path",
|
|
891
|
-
"source_schemas"
|
|
892
|
-
],
|
|
893
|
-
"type": "object"
|
|
894
|
-
},
|
|
895
|
-
{
|
|
896
|
-
"additionalProperties": false,
|
|
897
|
-
"properties": {
|
|
898
|
-
"compiled_schema": {
|
|
899
|
-
"type": "string"
|
|
900
|
-
}
|
|
901
|
-
},
|
|
902
|
-
"required": [
|
|
903
|
-
"compiled_schema"
|
|
904
|
-
],
|
|
905
|
-
"type": "object"
|
|
906
|
-
}
|
|
907
|
-
],
|
|
908
|
-
"description": "Used for internal capnp uploads for the Workers runtime"
|
|
909
|
-
},
|
|
910
|
-
"metadata": {
|
|
911
|
-
"additionalProperties": {},
|
|
912
|
-
"description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields.",
|
|
913
|
-
"type": "object"
|
|
914
|
-
}
|
|
915
|
-
},
|
|
916
|
-
"type": "object"
|
|
917
|
-
},
|
|
918
|
-
"upload_source_maps": {
|
|
919
|
-
"description": "Include source maps when uploading this worker.",
|
|
920
|
-
"type": "boolean"
|
|
921
|
-
},
|
|
922
|
-
"usage_model": {
|
|
923
|
-
"description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
|
|
924
|
-
"enum": [
|
|
925
|
-
"bundled",
|
|
926
|
-
"unbound"
|
|
927
|
-
],
|
|
928
|
-
"type": "string"
|
|
929
|
-
},
|
|
930
|
-
"vars": {
|
|
931
|
-
"additionalProperties": {
|
|
932
|
-
"anyOf": [
|
|
933
|
-
{
|
|
934
|
-
"type": "string"
|
|
935
|
-
},
|
|
936
|
-
{
|
|
937
|
-
"$ref": "#/definitions/Json"
|
|
938
|
-
}
|
|
939
|
-
]
|
|
940
|
-
},
|
|
941
|
-
"default": "`{}`",
|
|
942
|
-
"description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
943
|
-
"type": "object"
|
|
944
|
-
},
|
|
945
|
-
"vectorize": {
|
|
946
|
-
"default": "`[]`",
|
|
947
|
-
"description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
948
|
-
"items": {
|
|
949
|
-
"additionalProperties": false,
|
|
950
|
-
"properties": {
|
|
951
|
-
"binding": {
|
|
952
|
-
"description": "The binding name used to refer to the Vectorize index in the Worker.",
|
|
953
|
-
"type": "string"
|
|
954
|
-
},
|
|
955
|
-
"index_name": {
|
|
956
|
-
"description": "The name of the index.",
|
|
957
|
-
"type": "string"
|
|
958
|
-
}
|
|
959
|
-
},
|
|
960
|
-
"required": [
|
|
961
|
-
"binding",
|
|
962
|
-
"index_name"
|
|
963
|
-
],
|
|
964
|
-
"type": "object"
|
|
965
|
-
},
|
|
966
|
-
"type": "array"
|
|
967
|
-
},
|
|
968
|
-
"version_metadata": {
|
|
969
|
-
"additionalProperties": false,
|
|
970
|
-
"description": "Binding to the Worker Version's metadata",
|
|
971
|
-
"properties": {
|
|
972
|
-
"binding": {
|
|
973
|
-
"type": "string"
|
|
974
|
-
}
|
|
975
|
-
},
|
|
976
|
-
"required": [
|
|
977
|
-
"binding"
|
|
978
|
-
],
|
|
979
|
-
"type": "object"
|
|
980
|
-
},
|
|
981
|
-
"workers_dev": {
|
|
982
|
-
"default": "`true` (This is a breaking change from Wrangler v1)",
|
|
983
|
-
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.\n\n// Carmen according to our tests the default is undefined // warning: you must force \"workers_dev: true\" in tests to match expected behavior",
|
|
984
|
-
"type": "boolean"
|
|
985
|
-
},
|
|
986
|
-
"zone_id": {
|
|
987
|
-
"description": "TODO: remove this as it has been deprecated.\n\nThis is just here for now because the `route` commands use it. So we need to include it in this type so it is available.",
|
|
988
|
-
"type": "string"
|
|
989
|
-
}
|
|
990
|
-
},
|
|
991
|
-
"required": [
|
|
992
|
-
"analytics_engine_datasets",
|
|
993
|
-
"build",
|
|
994
|
-
"cloudchamber",
|
|
995
|
-
"compatibility_flags",
|
|
996
|
-
"d1_databases",
|
|
997
|
-
"define",
|
|
998
|
-
"dispatch_namespaces",
|
|
999
|
-
"durable_objects",
|
|
1000
|
-
"hyperdrive",
|
|
1001
|
-
"jsx_factory",
|
|
1002
|
-
"jsx_fragment",
|
|
1003
|
-
"kv_namespaces",
|
|
1004
|
-
"logfwdr",
|
|
1005
|
-
"migrations",
|
|
1006
|
-
"mtls_certificates",
|
|
1007
|
-
"pipelines",
|
|
1008
|
-
"queues",
|
|
1009
|
-
"r2_buckets",
|
|
1010
|
-
"rules",
|
|
1011
|
-
"send_email",
|
|
1012
|
-
"triggers",
|
|
1013
|
-
"unsafe",
|
|
1014
|
-
"vars",
|
|
1015
|
-
"vectorize"
|
|
1016
|
-
],
|
|
1017
|
-
"type": "object"
|
|
1018
|
-
},
|
|
1019
|
-
"ExperimentalAssets": {
|
|
1020
|
-
"additionalProperties": false,
|
|
1021
|
-
"properties": {
|
|
1022
|
-
"binding": {
|
|
1023
|
-
"type": "string"
|
|
1024
|
-
},
|
|
1025
|
-
"directory": {
|
|
1026
|
-
"description": "Absolute path to assets directory",
|
|
1027
|
-
"type": "string"
|
|
1028
|
-
},
|
|
1029
|
-
"html_handling": {
|
|
1030
|
-
"enum": [
|
|
1031
|
-
"auto-trailing-slash",
|
|
1032
|
-
"force-trailing-slash",
|
|
1033
|
-
"drop-trailing-slash",
|
|
1034
|
-
"none"
|
|
1035
|
-
],
|
|
1036
|
-
"type": "string"
|
|
1037
|
-
},
|
|
1038
|
-
"not_found_handling": {
|
|
1039
|
-
"enum": [
|
|
1040
|
-
"single-page-application",
|
|
1041
|
-
"404-page",
|
|
1042
|
-
"none"
|
|
1043
|
-
],
|
|
1044
|
-
"type": "string"
|
|
1045
|
-
}
|
|
1046
|
-
},
|
|
1047
|
-
"required": [
|
|
1048
|
-
"directory"
|
|
1049
|
-
],
|
|
1050
|
-
"type": "object"
|
|
1051
|
-
},
|
|
1052
|
-
"Json": {
|
|
1053
|
-
"anyOf": [
|
|
1054
|
-
{
|
|
1055
|
-
"$ref": "#/definitions/Literal"
|
|
1056
|
-
},
|
|
1057
|
-
{
|
|
1058
|
-
"additionalProperties": {
|
|
1059
|
-
"$ref": "#/definitions/Json"
|
|
1060
|
-
},
|
|
1061
|
-
"type": "object"
|
|
1062
|
-
},
|
|
1063
|
-
{
|
|
1064
|
-
"items": {
|
|
1065
|
-
"$ref": "#/definitions/Json"
|
|
1066
|
-
},
|
|
1067
|
-
"type": "array"
|
|
1068
|
-
}
|
|
1069
|
-
]
|
|
1070
|
-
},
|
|
1071
|
-
"Literal": {
|
|
1072
|
-
"$ref": "#/definitions/TypeOf%3CZodUnion%3C%5Bdef-class-1315922706-6501-8772-1315922706-0-54395%2Cdef-class-1315922706-9299-10989-1315922706-0-54395%2Cdef-class-1315922706-12937-13365-1315922706-0-54395%2Cdef-class-1315922706-15083-15273-1315922706-0-54395%5D%3E%3E"
|
|
1073
|
-
},
|
|
1074
|
-
"Observability": {
|
|
1075
|
-
"additionalProperties": false,
|
|
1076
|
-
"properties": {
|
|
1077
|
-
"enabled": {
|
|
1078
|
-
"description": "If observability is enabled for this Worker",
|
|
1079
|
-
"type": "boolean"
|
|
1080
|
-
},
|
|
1081
|
-
"head_sampling_rate": {
|
|
1082
|
-
"description": "The sampling rate",
|
|
1083
|
-
"type": "number"
|
|
1084
|
-
}
|
|
1085
|
-
},
|
|
1086
|
-
"required": [
|
|
1087
|
-
"enabled"
|
|
1088
|
-
],
|
|
1089
|
-
"type": "object"
|
|
1090
|
-
},
|
|
1091
|
-
"RawConfig": {
|
|
1092
|
-
"additionalProperties": false,
|
|
1093
|
-
"properties": {
|
|
1094
|
-
"$schema": {
|
|
1095
|
-
"type": "string"
|
|
1096
|
-
},
|
|
1097
|
-
"account_id": {
|
|
1098
|
-
"description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
|
|
1099
|
-
"type": "string"
|
|
1100
|
-
},
|
|
1101
|
-
"ai": {
|
|
1102
|
-
"additionalProperties": false,
|
|
1103
|
-
"default": "`{}`",
|
|
1104
|
-
"description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1105
|
-
"properties": {
|
|
1106
|
-
"binding": {
|
|
1107
|
-
"type": "string"
|
|
1108
|
-
},
|
|
1109
|
-
"staging": {
|
|
1110
|
-
"type": "boolean"
|
|
1111
|
-
}
|
|
1112
|
-
},
|
|
1113
|
-
"required": [
|
|
1114
|
-
"binding"
|
|
1115
|
-
],
|
|
1116
|
-
"type": "object"
|
|
1117
|
-
},
|
|
1118
|
-
"alias": {
|
|
1119
|
-
"additionalProperties": {
|
|
1120
|
-
"type": "string"
|
|
1121
|
-
},
|
|
1122
|
-
"description": "A map of module aliases. Lets you swap out a module for any others. Corresponds with esbuild's `alias` config",
|
|
1123
|
-
"type": "object"
|
|
1124
|
-
},
|
|
1125
|
-
"analytics_engine_datasets": {
|
|
1126
|
-
"default": "`[]`",
|
|
1127
|
-
"description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1128
|
-
"items": {
|
|
1129
|
-
"additionalProperties": false,
|
|
1130
|
-
"properties": {
|
|
1131
|
-
"binding": {
|
|
1132
|
-
"description": "The binding name used to refer to the dataset in the Worker.",
|
|
1133
|
-
"type": "string"
|
|
1134
|
-
},
|
|
1135
|
-
"dataset": {
|
|
1136
|
-
"description": "The name of this dataset to write to.",
|
|
1137
|
-
"type": "string"
|
|
1138
|
-
}
|
|
1139
|
-
},
|
|
1140
|
-
"required": [
|
|
1141
|
-
"binding"
|
|
1142
|
-
],
|
|
1143
|
-
"type": "object"
|
|
1144
|
-
},
|
|
1145
|
-
"type": "array"
|
|
1146
|
-
},
|
|
1147
|
-
"assets": {
|
|
1148
|
-
"anyOf": [
|
|
1149
|
-
{
|
|
1150
|
-
"additionalProperties": false,
|
|
1151
|
-
"properties": {
|
|
1152
|
-
"browser_TTL": {
|
|
1153
|
-
"type": "number"
|
|
1154
|
-
},
|
|
1155
|
-
"bucket": {
|
|
1156
|
-
"type": "string"
|
|
1157
|
-
},
|
|
1158
|
-
"exclude": {
|
|
1159
|
-
"items": {
|
|
1160
|
-
"type": "string"
|
|
1161
|
-
},
|
|
1162
|
-
"type": "array"
|
|
1163
|
-
},
|
|
1164
|
-
"include": {
|
|
1165
|
-
"items": {
|
|
1166
|
-
"type": "string"
|
|
1167
|
-
},
|
|
1168
|
-
"type": "array"
|
|
1169
|
-
},
|
|
1170
|
-
"serve_single_page_app": {
|
|
1171
|
-
"type": "boolean"
|
|
1172
|
-
}
|
|
398
|
+
"type": "string"
|
|
1173
399
|
},
|
|
1174
|
-
"
|
|
1175
|
-
"
|
|
1176
|
-
"
|
|
1177
|
-
|
|
1178
|
-
"serve_single_page_app"
|
|
1179
|
-
],
|
|
1180
|
-
"type": "object"
|
|
400
|
+
"dataset": {
|
|
401
|
+
"description": "The name of this dataset to write to.",
|
|
402
|
+
"type": "string"
|
|
403
|
+
}
|
|
1181
404
|
},
|
|
1182
|
-
|
|
1183
|
-
"
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
405
|
+
"required": [
|
|
406
|
+
"binding"
|
|
407
|
+
],
|
|
408
|
+
"type": "object"
|
|
409
|
+
},
|
|
410
|
+
"type": "array"
|
|
411
|
+
},
|
|
412
|
+
"assets": {
|
|
413
|
+
"$ref": "#/definitions/Assets",
|
|
414
|
+
"description": "Specify the directory of static assets to deploy/serve\n\nMore details at https://developers.cloudflare.com/workers/frameworks/"
|
|
1187
415
|
},
|
|
1188
416
|
"base_dir": {
|
|
1189
417
|
"description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
|
|
@@ -1191,7 +419,7 @@
|
|
|
1191
419
|
},
|
|
1192
420
|
"browser": {
|
|
1193
421
|
"additionalProperties": false,
|
|
1194
|
-
"default":
|
|
422
|
+
"default": {},
|
|
1195
423
|
"description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1196
424
|
"properties": {
|
|
1197
425
|
"binding": {
|
|
@@ -1218,11 +446,6 @@
|
|
|
1218
446
|
"description": "The directory in which the command is executed.",
|
|
1219
447
|
"type": "string"
|
|
1220
448
|
},
|
|
1221
|
-
"upload": {
|
|
1222
|
-
"$ref": "#/definitions/DeprecatedUpload",
|
|
1223
|
-
"deprecated": true,
|
|
1224
|
-
"description": "Deprecated field previously used to configure the build and upload of the script."
|
|
1225
|
-
},
|
|
1226
449
|
"watch_dir": {
|
|
1227
450
|
"anyOf": [
|
|
1228
451
|
{
|
|
@@ -1242,7 +465,7 @@
|
|
|
1242
465
|
},
|
|
1243
466
|
"cloudchamber": {
|
|
1244
467
|
"$ref": "#/definitions/CloudchamberConfig",
|
|
1245
|
-
"default":
|
|
468
|
+
"default": {},
|
|
1246
469
|
"description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
|
|
1247
470
|
},
|
|
1248
471
|
"compatibility_date": {
|
|
@@ -1250,18 +473,33 @@
|
|
|
1250
473
|
"type": "string"
|
|
1251
474
|
},
|
|
1252
475
|
"compatibility_flags": {
|
|
1253
|
-
"default":
|
|
1254
|
-
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with
|
|
476
|
+
"default": [],
|
|
477
|
+
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_date.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-flags",
|
|
1255
478
|
"items": {
|
|
1256
479
|
"type": "string"
|
|
1257
480
|
},
|
|
1258
481
|
"type": "array"
|
|
1259
482
|
},
|
|
1260
|
-
"
|
|
1261
|
-
"
|
|
483
|
+
"containers": {
|
|
484
|
+
"additionalProperties": false,
|
|
485
|
+
"description": "Container related configuration",
|
|
486
|
+
"properties": {
|
|
487
|
+
"app": {
|
|
488
|
+
"default": {},
|
|
489
|
+
"description": "Container app configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
490
|
+
"items": {
|
|
491
|
+
"$ref": "#/definitions/ContainerApp"
|
|
492
|
+
},
|
|
493
|
+
"type": "array"
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
"required": [
|
|
497
|
+
"app"
|
|
498
|
+
],
|
|
499
|
+
"type": "object"
|
|
1262
500
|
},
|
|
1263
501
|
"d1_databases": {
|
|
1264
|
-
"default":
|
|
502
|
+
"default": [],
|
|
1265
503
|
"description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1266
504
|
"items": {
|
|
1267
505
|
"additionalProperties": false,
|
|
@@ -1296,9 +534,7 @@
|
|
|
1296
534
|
}
|
|
1297
535
|
},
|
|
1298
536
|
"required": [
|
|
1299
|
-
"binding"
|
|
1300
|
-
"database_name",
|
|
1301
|
-
"database_id"
|
|
537
|
+
"binding"
|
|
1302
538
|
],
|
|
1303
539
|
"type": "object"
|
|
1304
540
|
},
|
|
@@ -1315,7 +551,7 @@
|
|
|
1315
551
|
"additionalProperties": {
|
|
1316
552
|
"type": "string"
|
|
1317
553
|
},
|
|
1318
|
-
"default":
|
|
554
|
+
"default": {},
|
|
1319
555
|
"description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1320
556
|
"type": "object"
|
|
1321
557
|
},
|
|
@@ -1324,7 +560,7 @@
|
|
|
1324
560
|
"description": "Options to configure the development server that your worker will use."
|
|
1325
561
|
},
|
|
1326
562
|
"dispatch_namespaces": {
|
|
1327
|
-
"default":
|
|
563
|
+
"default": [],
|
|
1328
564
|
"description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1329
565
|
"items": {
|
|
1330
566
|
"additionalProperties": false,
|
|
@@ -1352,7 +588,9 @@
|
|
|
1352
588
|
},
|
|
1353
589
|
"durable_objects": {
|
|
1354
590
|
"additionalProperties": false,
|
|
1355
|
-
"default":
|
|
591
|
+
"default": {
|
|
592
|
+
"bindings": []
|
|
593
|
+
},
|
|
1356
594
|
"description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1357
595
|
"properties": {
|
|
1358
596
|
"bindings": {
|
|
@@ -1372,39 +610,6 @@
|
|
|
1372
610
|
"description": "The `env` section defines overrides for the configuration for different environments.\n\nAll environment fields can be specified at the top level of the config indicating the default environment settings.\n\n- Some fields are inherited and overridable in each environment.\n- But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.\n\nFor more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments",
|
|
1373
611
|
"type": "object"
|
|
1374
612
|
},
|
|
1375
|
-
"experimental_assets": {
|
|
1376
|
-
"$ref": "#/definitions/ExperimentalAssets",
|
|
1377
|
-
"description": "Specify the directory of static assets to deploy/serve"
|
|
1378
|
-
},
|
|
1379
|
-
"experimental_services": {
|
|
1380
|
-
"default": "`[]`",
|
|
1381
|
-
"deprecated": "DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.",
|
|
1382
|
-
"description": "A list of services that your Worker should be bound to.",
|
|
1383
|
-
"items": {
|
|
1384
|
-
"additionalProperties": false,
|
|
1385
|
-
"properties": {
|
|
1386
|
-
"environment": {
|
|
1387
|
-
"description": "The Service's environment",
|
|
1388
|
-
"type": "string"
|
|
1389
|
-
},
|
|
1390
|
-
"name": {
|
|
1391
|
-
"description": "The binding name used to refer to the Service",
|
|
1392
|
-
"type": "string"
|
|
1393
|
-
},
|
|
1394
|
-
"service": {
|
|
1395
|
-
"description": "The name of the Service being bound",
|
|
1396
|
-
"type": "string"
|
|
1397
|
-
}
|
|
1398
|
-
},
|
|
1399
|
-
"required": [
|
|
1400
|
-
"name",
|
|
1401
|
-
"service",
|
|
1402
|
-
"environment"
|
|
1403
|
-
],
|
|
1404
|
-
"type": "object"
|
|
1405
|
-
},
|
|
1406
|
-
"type": "array"
|
|
1407
|
-
},
|
|
1408
613
|
"find_additional_modules": {
|
|
1409
614
|
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
|
|
1410
615
|
"type": "boolean"
|
|
@@ -1414,7 +619,7 @@
|
|
|
1414
619
|
"type": "boolean"
|
|
1415
620
|
},
|
|
1416
621
|
"hyperdrive": {
|
|
1417
|
-
"default":
|
|
622
|
+
"default": [],
|
|
1418
623
|
"description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1419
624
|
"items": {
|
|
1420
625
|
"additionalProperties": false,
|
|
@@ -1440,28 +645,37 @@
|
|
|
1440
645
|
},
|
|
1441
646
|
"type": "array"
|
|
1442
647
|
},
|
|
648
|
+
"images": {
|
|
649
|
+
"additionalProperties": false,
|
|
650
|
+
"default": {},
|
|
651
|
+
"description": "Binding to Cloudflare Images\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
652
|
+
"properties": {
|
|
653
|
+
"binding": {
|
|
654
|
+
"type": "string"
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
"required": [
|
|
658
|
+
"binding"
|
|
659
|
+
],
|
|
660
|
+
"type": "object"
|
|
661
|
+
},
|
|
1443
662
|
"jsx_factory": {
|
|
1444
|
-
"default": "
|
|
663
|
+
"default": "React.createElement",
|
|
1445
664
|
"description": "The function to use to replace jsx syntax.",
|
|
1446
665
|
"type": "string"
|
|
1447
666
|
},
|
|
1448
667
|
"jsx_fragment": {
|
|
1449
|
-
"default": "
|
|
668
|
+
"default": "React.Fragment",
|
|
1450
669
|
"description": "The function to use to replace jsx fragment syntax.",
|
|
1451
670
|
"type": "string"
|
|
1452
671
|
},
|
|
1453
672
|
"keep_vars": {
|
|
1454
673
|
"default": false,
|
|
1455
|
-
"description": "By default,
|
|
674
|
+
"description": "By default, the Wrangler configuration file is the source of truth for your environment configuration, like a terraform file.\n\nIf you change your vars in the dashboard, wrangler *will* override/delete them on its next deploy.\n\nIf you want to keep your dashboard vars when wrangler deploys, set this field to true.",
|
|
1456
675
|
"type": "boolean"
|
|
1457
676
|
},
|
|
1458
|
-
"kv-namespaces": {
|
|
1459
|
-
"deprecated": "DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.",
|
|
1460
|
-
"description": "Legacy way of defining KVNamespaces that is no longer supported.",
|
|
1461
|
-
"type": "string"
|
|
1462
|
-
},
|
|
1463
677
|
"kv_namespaces": {
|
|
1464
|
-
"default":
|
|
678
|
+
"default": [],
|
|
1465
679
|
"description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1466
680
|
"items": {
|
|
1467
681
|
"additionalProperties": false,
|
|
@@ -1480,54 +694,12 @@
|
|
|
1480
694
|
}
|
|
1481
695
|
},
|
|
1482
696
|
"required": [
|
|
1483
|
-
"binding"
|
|
1484
|
-
"id"
|
|
697
|
+
"binding"
|
|
1485
698
|
],
|
|
1486
699
|
"type": "object"
|
|
1487
700
|
},
|
|
1488
701
|
"type": "array"
|
|
1489
702
|
},
|
|
1490
|
-
"legacy_assets": {
|
|
1491
|
-
"anyOf": [
|
|
1492
|
-
{
|
|
1493
|
-
"additionalProperties": false,
|
|
1494
|
-
"properties": {
|
|
1495
|
-
"browser_TTL": {
|
|
1496
|
-
"type": "number"
|
|
1497
|
-
},
|
|
1498
|
-
"bucket": {
|
|
1499
|
-
"type": "string"
|
|
1500
|
-
},
|
|
1501
|
-
"exclude": {
|
|
1502
|
-
"items": {
|
|
1503
|
-
"type": "string"
|
|
1504
|
-
},
|
|
1505
|
-
"type": "array"
|
|
1506
|
-
},
|
|
1507
|
-
"include": {
|
|
1508
|
-
"items": {
|
|
1509
|
-
"type": "string"
|
|
1510
|
-
},
|
|
1511
|
-
"type": "array"
|
|
1512
|
-
},
|
|
1513
|
-
"serve_single_page_app": {
|
|
1514
|
-
"type": "boolean"
|
|
1515
|
-
}
|
|
1516
|
-
},
|
|
1517
|
-
"required": [
|
|
1518
|
-
"bucket",
|
|
1519
|
-
"include",
|
|
1520
|
-
"exclude",
|
|
1521
|
-
"serve_single_page_app"
|
|
1522
|
-
],
|
|
1523
|
-
"type": "object"
|
|
1524
|
-
},
|
|
1525
|
-
{
|
|
1526
|
-
"type": "string"
|
|
1527
|
-
}
|
|
1528
|
-
],
|
|
1529
|
-
"description": "Serve a folder of static assets with your Worker, without any additional code. This can either be a string, or an object with additional config fields. Only one of assets and legacy_assets can be used."
|
|
1530
|
-
},
|
|
1531
703
|
"legacy_env": {
|
|
1532
704
|
"description": "A boolean to enable \"legacy\" style wrangler environments (from Wrangler v1). These have been superseded by Services, but there may be projects that won't (or can't) use them. If you're using a legacy environment, you can set this to `true` to enable it.",
|
|
1533
705
|
"type": "boolean"
|
|
@@ -1538,7 +710,9 @@
|
|
|
1538
710
|
},
|
|
1539
711
|
"logfwdr": {
|
|
1540
712
|
"additionalProperties": false,
|
|
1541
|
-
"default":
|
|
713
|
+
"default": {
|
|
714
|
+
"bindings": []
|
|
715
|
+
},
|
|
1542
716
|
"description": "List of bindings that you will send to logfwdr",
|
|
1543
717
|
"properties": {
|
|
1544
718
|
"bindings": {
|
|
@@ -1584,16 +758,12 @@
|
|
|
1584
758
|
},
|
|
1585
759
|
"type": "array"
|
|
1586
760
|
},
|
|
1587
|
-
"miniflare": {
|
|
1588
|
-
"deprecated": true,
|
|
1589
|
-
"description": "Configuration only used by a standalone use of the miniflare binary."
|
|
1590
|
-
},
|
|
1591
761
|
"minify": {
|
|
1592
762
|
"description": "Minify the script before uploading.",
|
|
1593
763
|
"type": "boolean"
|
|
1594
764
|
},
|
|
1595
765
|
"mtls_certificates": {
|
|
1596
|
-
"default":
|
|
766
|
+
"default": [],
|
|
1597
767
|
"description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1598
768
|
"items": {
|
|
1599
769
|
"additionalProperties": false,
|
|
@@ -1623,20 +793,16 @@
|
|
|
1623
793
|
"description": "Skip internal build steps and directly deploy script",
|
|
1624
794
|
"type": "boolean"
|
|
1625
795
|
},
|
|
1626
|
-
"node_compat": {
|
|
1627
|
-
"description": "Add polyfills for node builtin modules and globals",
|
|
1628
|
-
"type": "boolean"
|
|
1629
|
-
},
|
|
1630
796
|
"observability": {
|
|
1631
797
|
"$ref": "#/definitions/Observability",
|
|
1632
798
|
"description": "Specify the observability behavior of the Worker."
|
|
1633
799
|
},
|
|
1634
800
|
"pages_build_output_dir": {
|
|
1635
|
-
"description": "The directory of static assets to serve.\n\nThe presence of this field in
|
|
801
|
+
"description": "The directory of static assets to serve.\n\nThe presence of this field in a Wrangler configuration file indicates a Pages project, and will prompt the handling of the configuration file according to the Pages-specific validation rules.",
|
|
1636
802
|
"type": "string"
|
|
1637
803
|
},
|
|
1638
804
|
"pipelines": {
|
|
1639
|
-
"default":
|
|
805
|
+
"default": [],
|
|
1640
806
|
"description": "Specifies list of Pipelines bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1641
807
|
"items": {
|
|
1642
808
|
"additionalProperties": false,
|
|
@@ -1682,9 +848,17 @@
|
|
|
1682
848
|
"description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
|
|
1683
849
|
"type": "boolean"
|
|
1684
850
|
},
|
|
851
|
+
"preview_urls": {
|
|
852
|
+
"default": true,
|
|
853
|
+
"description": "Whether we use <version>-<name>.<subdomain>.workers.dev to serve Preview URLs for your Worker.",
|
|
854
|
+
"type": "boolean"
|
|
855
|
+
},
|
|
1685
856
|
"queues": {
|
|
1686
857
|
"additionalProperties": false,
|
|
1687
|
-
"default":
|
|
858
|
+
"default": {
|
|
859
|
+
"consumers": [],
|
|
860
|
+
"producers": []
|
|
861
|
+
},
|
|
1688
862
|
"description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1689
863
|
"properties": {
|
|
1690
864
|
"consumers": {
|
|
@@ -1769,7 +943,7 @@
|
|
|
1769
943
|
"type": "object"
|
|
1770
944
|
},
|
|
1771
945
|
"r2_buckets": {
|
|
1772
|
-
"default":
|
|
946
|
+
"default": [],
|
|
1773
947
|
"description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1774
948
|
"items": {
|
|
1775
949
|
"additionalProperties": false,
|
|
@@ -1792,8 +966,7 @@
|
|
|
1792
966
|
}
|
|
1793
967
|
},
|
|
1794
968
|
"required": [
|
|
1795
|
-
"binding"
|
|
1796
|
-
"bucket_name"
|
|
969
|
+
"binding"
|
|
1797
970
|
],
|
|
1798
971
|
"type": "object"
|
|
1799
972
|
},
|
|
@@ -1818,7 +991,7 @@
|
|
|
1818
991
|
"type": "array"
|
|
1819
992
|
},
|
|
1820
993
|
"send_email": {
|
|
1821
|
-
"default":
|
|
994
|
+
"default": [],
|
|
1822
995
|
"description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1823
996
|
"items": {
|
|
1824
997
|
"additionalProperties": false,
|
|
@@ -1851,7 +1024,7 @@
|
|
|
1851
1024
|
"type": "boolean"
|
|
1852
1025
|
},
|
|
1853
1026
|
"services": {
|
|
1854
|
-
"default":
|
|
1027
|
+
"default": [],
|
|
1855
1028
|
"description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1856
1029
|
"items": {
|
|
1857
1030
|
"additionalProperties": false,
|
|
@@ -1886,7 +1059,7 @@
|
|
|
1886
1059
|
"description": "The definition of a Worker Site, a feature that lets you upload static assets with your Worker.\n\nMore details at https://developers.cloudflare.com/workers/platform/sites",
|
|
1887
1060
|
"properties": {
|
|
1888
1061
|
"bucket": {
|
|
1889
|
-
"description": "The directory containing your static assets.\n\nIt must be a path relative to your
|
|
1062
|
+
"description": "The directory containing your static assets.\n\nIt must be a path relative to your Wrangler configuration file. Example: bucket = \"./public\"\n\nIf there is a `site` field then it must contain this `bucket` field.",
|
|
1890
1063
|
"type": "string"
|
|
1891
1064
|
},
|
|
1892
1065
|
"entry-point": {
|
|
@@ -1917,7 +1090,7 @@
|
|
|
1917
1090
|
"type": "object"
|
|
1918
1091
|
},
|
|
1919
1092
|
"tail_consumers": {
|
|
1920
|
-
"default":
|
|
1093
|
+
"default": [],
|
|
1921
1094
|
"description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1922
1095
|
"items": {
|
|
1923
1096
|
"$ref": "#/definitions/TailConsumer"
|
|
@@ -1933,7 +1106,9 @@
|
|
|
1933
1106
|
},
|
|
1934
1107
|
"triggers": {
|
|
1935
1108
|
"additionalProperties": false,
|
|
1936
|
-
"default":
|
|
1109
|
+
"default": {
|
|
1110
|
+
"crons": []
|
|
1111
|
+
},
|
|
1937
1112
|
"description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
|
|
1938
1113
|
"properties": {
|
|
1939
1114
|
"crons": {
|
|
@@ -1952,19 +1127,9 @@
|
|
|
1952
1127
|
"description": "Path to a custom tsconfig",
|
|
1953
1128
|
"type": "string"
|
|
1954
1129
|
},
|
|
1955
|
-
"type": {
|
|
1956
|
-
"deprecated": "DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
|
|
1957
|
-
"description": "The project \"type\". A holdover from Wrangler v1.x. Valid values were \"webpack\", \"javascript\", and \"rust\".",
|
|
1958
|
-
"enum": [
|
|
1959
|
-
"webpack",
|
|
1960
|
-
"javascript",
|
|
1961
|
-
"rust"
|
|
1962
|
-
],
|
|
1963
|
-
"type": "string"
|
|
1964
|
-
},
|
|
1965
1130
|
"unsafe": {
|
|
1966
1131
|
"additionalProperties": false,
|
|
1967
|
-
"default":
|
|
1132
|
+
"default": {},
|
|
1968
1133
|
"description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1969
1134
|
"properties": {
|
|
1970
1135
|
"bindings": {
|
|
@@ -2035,14 +1200,6 @@
|
|
|
2035
1200
|
"description": "Include source maps when uploading this worker.",
|
|
2036
1201
|
"type": "boolean"
|
|
2037
1202
|
},
|
|
2038
|
-
"usage_model": {
|
|
2039
|
-
"description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
|
|
2040
|
-
"enum": [
|
|
2041
|
-
"bundled",
|
|
2042
|
-
"unbound"
|
|
2043
|
-
],
|
|
2044
|
-
"type": "string"
|
|
2045
|
-
},
|
|
2046
1203
|
"vars": {
|
|
2047
1204
|
"additionalProperties": {
|
|
2048
1205
|
"anyOf": [
|
|
@@ -2054,12 +1211,12 @@
|
|
|
2054
1211
|
}
|
|
2055
1212
|
]
|
|
2056
1213
|
},
|
|
2057
|
-
"default":
|
|
1214
|
+
"default": {},
|
|
2058
1215
|
"description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2059
1216
|
"type": "object"
|
|
2060
1217
|
},
|
|
2061
1218
|
"vectorize": {
|
|
2062
|
-
"default":
|
|
1219
|
+
"default": [],
|
|
2063
1220
|
"description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2064
1221
|
"items": {
|
|
2065
1222
|
"additionalProperties": false,
|
|
@@ -2101,19 +1258,18 @@
|
|
|
2101
1258
|
"description": "A list of wasm modules that your worker should be bound to. This is the \"legacy\" way of binding to a wasm module. ES module workers should do proper module imports.",
|
|
2102
1259
|
"type": "object"
|
|
2103
1260
|
},
|
|
2104
|
-
"webpack_config": {
|
|
2105
|
-
"deprecated": "DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
|
|
2106
|
-
"description": "Path to the webpack config to use when building your worker. A holdover from Wrangler v1.x, used with `type: \"webpack\"`.",
|
|
2107
|
-
"type": "string"
|
|
2108
|
-
},
|
|
2109
1261
|
"workers_dev": {
|
|
2110
|
-
"default":
|
|
2111
|
-
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker
|
|
1262
|
+
"default": true,
|
|
1263
|
+
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.",
|
|
2112
1264
|
"type": "boolean"
|
|
2113
1265
|
},
|
|
2114
|
-
"
|
|
2115
|
-
"
|
|
2116
|
-
"
|
|
1266
|
+
"workflows": {
|
|
1267
|
+
"default": [],
|
|
1268
|
+
"description": "A list of workflows that your Worker should be bound to.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1269
|
+
"items": {
|
|
1270
|
+
"$ref": "#/definitions/WorkflowBinding"
|
|
1271
|
+
},
|
|
1272
|
+
"type": "array"
|
|
2117
1273
|
}
|
|
2118
1274
|
},
|
|
2119
1275
|
"type": "object"
|
|
@@ -2171,7 +1327,7 @@
|
|
|
2171
1327
|
},
|
|
2172
1328
|
"ai": {
|
|
2173
1329
|
"additionalProperties": false,
|
|
2174
|
-
"default":
|
|
1330
|
+
"default": {},
|
|
2175
1331
|
"description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2176
1332
|
"properties": {
|
|
2177
1333
|
"binding": {
|
|
@@ -2187,7 +1343,7 @@
|
|
|
2187
1343
|
"type": "object"
|
|
2188
1344
|
},
|
|
2189
1345
|
"analytics_engine_datasets": {
|
|
2190
|
-
"default":
|
|
1346
|
+
"default": [],
|
|
2191
1347
|
"description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2192
1348
|
"items": {
|
|
2193
1349
|
"additionalProperties": false,
|
|
@@ -2208,13 +1364,17 @@
|
|
|
2208
1364
|
},
|
|
2209
1365
|
"type": "array"
|
|
2210
1366
|
},
|
|
1367
|
+
"assets": {
|
|
1368
|
+
"$ref": "#/definitions/Assets",
|
|
1369
|
+
"description": "Specify the directory of static assets to deploy/serve\n\nMore details at https://developers.cloudflare.com/workers/frameworks/"
|
|
1370
|
+
},
|
|
2211
1371
|
"base_dir": {
|
|
2212
1372
|
"description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
|
|
2213
1373
|
"type": "string"
|
|
2214
1374
|
},
|
|
2215
1375
|
"browser": {
|
|
2216
1376
|
"additionalProperties": false,
|
|
2217
|
-
"default":
|
|
1377
|
+
"default": {},
|
|
2218
1378
|
"description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2219
1379
|
"properties": {
|
|
2220
1380
|
"binding": {
|
|
@@ -2241,11 +1401,6 @@
|
|
|
2241
1401
|
"description": "The directory in which the command is executed.",
|
|
2242
1402
|
"type": "string"
|
|
2243
1403
|
},
|
|
2244
|
-
"upload": {
|
|
2245
|
-
"$ref": "#/definitions/DeprecatedUpload",
|
|
2246
|
-
"deprecated": true,
|
|
2247
|
-
"description": "Deprecated field previously used to configure the build and upload of the script."
|
|
2248
|
-
},
|
|
2249
1404
|
"watch_dir": {
|
|
2250
1405
|
"anyOf": [
|
|
2251
1406
|
{
|
|
@@ -2265,7 +1420,7 @@
|
|
|
2265
1420
|
},
|
|
2266
1421
|
"cloudchamber": {
|
|
2267
1422
|
"$ref": "#/definitions/CloudchamberConfig",
|
|
2268
|
-
"default":
|
|
1423
|
+
"default": {},
|
|
2269
1424
|
"description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
|
|
2270
1425
|
},
|
|
2271
1426
|
"compatibility_date": {
|
|
@@ -2273,15 +1428,33 @@
|
|
|
2273
1428
|
"type": "string"
|
|
2274
1429
|
},
|
|
2275
1430
|
"compatibility_flags": {
|
|
2276
|
-
"default":
|
|
2277
|
-
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with
|
|
1431
|
+
"default": [],
|
|
1432
|
+
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_date.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-flags",
|
|
2278
1433
|
"items": {
|
|
2279
1434
|
"type": "string"
|
|
2280
1435
|
},
|
|
2281
1436
|
"type": "array"
|
|
2282
1437
|
},
|
|
1438
|
+
"containers": {
|
|
1439
|
+
"additionalProperties": false,
|
|
1440
|
+
"description": "Container related configuration",
|
|
1441
|
+
"properties": {
|
|
1442
|
+
"app": {
|
|
1443
|
+
"default": {},
|
|
1444
|
+
"description": "Container app configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1445
|
+
"items": {
|
|
1446
|
+
"$ref": "#/definitions/ContainerApp"
|
|
1447
|
+
},
|
|
1448
|
+
"type": "array"
|
|
1449
|
+
}
|
|
1450
|
+
},
|
|
1451
|
+
"required": [
|
|
1452
|
+
"app"
|
|
1453
|
+
],
|
|
1454
|
+
"type": "object"
|
|
1455
|
+
},
|
|
2283
1456
|
"d1_databases": {
|
|
2284
|
-
"default":
|
|
1457
|
+
"default": [],
|
|
2285
1458
|
"description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2286
1459
|
"items": {
|
|
2287
1460
|
"additionalProperties": false,
|
|
@@ -2316,9 +1489,7 @@
|
|
|
2316
1489
|
}
|
|
2317
1490
|
},
|
|
2318
1491
|
"required": [
|
|
2319
|
-
"binding"
|
|
2320
|
-
"database_name",
|
|
2321
|
-
"database_id"
|
|
1492
|
+
"binding"
|
|
2322
1493
|
],
|
|
2323
1494
|
"type": "object"
|
|
2324
1495
|
},
|
|
@@ -2328,12 +1499,12 @@
|
|
|
2328
1499
|
"additionalProperties": {
|
|
2329
1500
|
"type": "string"
|
|
2330
1501
|
},
|
|
2331
|
-
"default":
|
|
1502
|
+
"default": {},
|
|
2332
1503
|
"description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2333
1504
|
"type": "object"
|
|
2334
1505
|
},
|
|
2335
1506
|
"dispatch_namespaces": {
|
|
2336
|
-
"default":
|
|
1507
|
+
"default": [],
|
|
2337
1508
|
"description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2338
1509
|
"items": {
|
|
2339
1510
|
"additionalProperties": false,
|
|
@@ -2361,7 +1532,9 @@
|
|
|
2361
1532
|
},
|
|
2362
1533
|
"durable_objects": {
|
|
2363
1534
|
"additionalProperties": false,
|
|
2364
|
-
"default":
|
|
1535
|
+
"default": {
|
|
1536
|
+
"bindings": []
|
|
1537
|
+
},
|
|
2365
1538
|
"description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2366
1539
|
"properties": {
|
|
2367
1540
|
"bindings": {
|
|
@@ -2373,39 +1546,6 @@
|
|
|
2373
1546
|
],
|
|
2374
1547
|
"type": "object"
|
|
2375
1548
|
},
|
|
2376
|
-
"experimental_assets": {
|
|
2377
|
-
"$ref": "#/definitions/ExperimentalAssets",
|
|
2378
|
-
"description": "Specify the directory of static assets to deploy/serve"
|
|
2379
|
-
},
|
|
2380
|
-
"experimental_services": {
|
|
2381
|
-
"default": "`[]`",
|
|
2382
|
-
"deprecated": "DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.",
|
|
2383
|
-
"description": "A list of services that your Worker should be bound to.",
|
|
2384
|
-
"items": {
|
|
2385
|
-
"additionalProperties": false,
|
|
2386
|
-
"properties": {
|
|
2387
|
-
"environment": {
|
|
2388
|
-
"description": "The Service's environment",
|
|
2389
|
-
"type": "string"
|
|
2390
|
-
},
|
|
2391
|
-
"name": {
|
|
2392
|
-
"description": "The binding name used to refer to the Service",
|
|
2393
|
-
"type": "string"
|
|
2394
|
-
},
|
|
2395
|
-
"service": {
|
|
2396
|
-
"description": "The name of the Service being bound",
|
|
2397
|
-
"type": "string"
|
|
2398
|
-
}
|
|
2399
|
-
},
|
|
2400
|
-
"required": [
|
|
2401
|
-
"name",
|
|
2402
|
-
"service",
|
|
2403
|
-
"environment"
|
|
2404
|
-
],
|
|
2405
|
-
"type": "object"
|
|
2406
|
-
},
|
|
2407
|
-
"type": "array"
|
|
2408
|
-
},
|
|
2409
1549
|
"find_additional_modules": {
|
|
2410
1550
|
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
|
|
2411
1551
|
"type": "boolean"
|
|
@@ -2415,7 +1555,7 @@
|
|
|
2415
1555
|
"type": "boolean"
|
|
2416
1556
|
},
|
|
2417
1557
|
"hyperdrive": {
|
|
2418
|
-
"default":
|
|
1558
|
+
"default": [],
|
|
2419
1559
|
"description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2420
1560
|
"items": {
|
|
2421
1561
|
"additionalProperties": false,
|
|
@@ -2441,23 +1581,32 @@
|
|
|
2441
1581
|
},
|
|
2442
1582
|
"type": "array"
|
|
2443
1583
|
},
|
|
1584
|
+
"images": {
|
|
1585
|
+
"additionalProperties": false,
|
|
1586
|
+
"default": {},
|
|
1587
|
+
"description": "Binding to Cloudflare Images\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
1588
|
+
"properties": {
|
|
1589
|
+
"binding": {
|
|
1590
|
+
"type": "string"
|
|
1591
|
+
}
|
|
1592
|
+
},
|
|
1593
|
+
"required": [
|
|
1594
|
+
"binding"
|
|
1595
|
+
],
|
|
1596
|
+
"type": "object"
|
|
1597
|
+
},
|
|
2444
1598
|
"jsx_factory": {
|
|
2445
|
-
"default": "
|
|
1599
|
+
"default": "React.createElement",
|
|
2446
1600
|
"description": "The function to use to replace jsx syntax.",
|
|
2447
1601
|
"type": "string"
|
|
2448
1602
|
},
|
|
2449
1603
|
"jsx_fragment": {
|
|
2450
|
-
"default": "
|
|
1604
|
+
"default": "React.Fragment",
|
|
2451
1605
|
"description": "The function to use to replace jsx fragment syntax.",
|
|
2452
1606
|
"type": "string"
|
|
2453
1607
|
},
|
|
2454
|
-
"kv-namespaces": {
|
|
2455
|
-
"deprecated": "DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.",
|
|
2456
|
-
"description": "Legacy way of defining KVNamespaces that is no longer supported.",
|
|
2457
|
-
"type": "string"
|
|
2458
|
-
},
|
|
2459
1608
|
"kv_namespaces": {
|
|
2460
|
-
"default":
|
|
1609
|
+
"default": [],
|
|
2461
1610
|
"description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2462
1611
|
"items": {
|
|
2463
1612
|
"additionalProperties": false,
|
|
@@ -2476,8 +1625,7 @@
|
|
|
2476
1625
|
}
|
|
2477
1626
|
},
|
|
2478
1627
|
"required": [
|
|
2479
|
-
"binding"
|
|
2480
|
-
"id"
|
|
1628
|
+
"binding"
|
|
2481
1629
|
],
|
|
2482
1630
|
"type": "object"
|
|
2483
1631
|
},
|
|
@@ -2489,7 +1637,9 @@
|
|
|
2489
1637
|
},
|
|
2490
1638
|
"logfwdr": {
|
|
2491
1639
|
"additionalProperties": false,
|
|
2492
|
-
"default":
|
|
1640
|
+
"default": {
|
|
1641
|
+
"bindings": []
|
|
1642
|
+
},
|
|
2493
1643
|
"description": "List of bindings that you will send to logfwdr",
|
|
2494
1644
|
"properties": {
|
|
2495
1645
|
"bindings": {
|
|
@@ -2540,7 +1690,7 @@
|
|
|
2540
1690
|
"type": "boolean"
|
|
2541
1691
|
},
|
|
2542
1692
|
"mtls_certificates": {
|
|
2543
|
-
"default":
|
|
1693
|
+
"default": [],
|
|
2544
1694
|
"description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2545
1695
|
"items": {
|
|
2546
1696
|
"additionalProperties": false,
|
|
@@ -2570,16 +1720,12 @@
|
|
|
2570
1720
|
"description": "Skip internal build steps and directly deploy script",
|
|
2571
1721
|
"type": "boolean"
|
|
2572
1722
|
},
|
|
2573
|
-
"node_compat": {
|
|
2574
|
-
"description": "Add polyfills for node builtin modules and globals",
|
|
2575
|
-
"type": "boolean"
|
|
2576
|
-
},
|
|
2577
1723
|
"observability": {
|
|
2578
1724
|
"$ref": "#/definitions/Observability",
|
|
2579
1725
|
"description": "Specify the observability behavior of the Worker."
|
|
2580
1726
|
},
|
|
2581
1727
|
"pipelines": {
|
|
2582
|
-
"default":
|
|
1728
|
+
"default": [],
|
|
2583
1729
|
"description": "Specifies list of Pipelines bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2584
1730
|
"items": {
|
|
2585
1731
|
"additionalProperties": false,
|
|
@@ -2625,9 +1771,17 @@
|
|
|
2625
1771
|
"description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
|
|
2626
1772
|
"type": "boolean"
|
|
2627
1773
|
},
|
|
1774
|
+
"preview_urls": {
|
|
1775
|
+
"default": true,
|
|
1776
|
+
"description": "Whether we use <version>-<name>.<subdomain>.workers.dev to serve Preview URLs for your Worker.",
|
|
1777
|
+
"type": "boolean"
|
|
1778
|
+
},
|
|
2628
1779
|
"queues": {
|
|
2629
1780
|
"additionalProperties": false,
|
|
2630
|
-
"default":
|
|
1781
|
+
"default": {
|
|
1782
|
+
"consumers": [],
|
|
1783
|
+
"producers": []
|
|
1784
|
+
},
|
|
2631
1785
|
"description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2632
1786
|
"properties": {
|
|
2633
1787
|
"consumers": {
|
|
@@ -2712,7 +1866,7 @@
|
|
|
2712
1866
|
"type": "object"
|
|
2713
1867
|
},
|
|
2714
1868
|
"r2_buckets": {
|
|
2715
|
-
"default":
|
|
1869
|
+
"default": [],
|
|
2716
1870
|
"description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2717
1871
|
"items": {
|
|
2718
1872
|
"additionalProperties": false,
|
|
@@ -2735,8 +1889,7 @@
|
|
|
2735
1889
|
}
|
|
2736
1890
|
},
|
|
2737
1891
|
"required": [
|
|
2738
|
-
"binding"
|
|
2739
|
-
"bucket_name"
|
|
1892
|
+
"binding"
|
|
2740
1893
|
],
|
|
2741
1894
|
"type": "object"
|
|
2742
1895
|
},
|
|
@@ -2761,7 +1914,7 @@
|
|
|
2761
1914
|
"type": "array"
|
|
2762
1915
|
},
|
|
2763
1916
|
"send_email": {
|
|
2764
|
-
"default":
|
|
1917
|
+
"default": [],
|
|
2765
1918
|
"description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2766
1919
|
"items": {
|
|
2767
1920
|
"additionalProperties": false,
|
|
@@ -2790,7 +1943,7 @@
|
|
|
2790
1943
|
"type": "array"
|
|
2791
1944
|
},
|
|
2792
1945
|
"services": {
|
|
2793
|
-
"default":
|
|
1946
|
+
"default": [],
|
|
2794
1947
|
"description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2795
1948
|
"items": {
|
|
2796
1949
|
"additionalProperties": false,
|
|
@@ -2821,7 +1974,7 @@
|
|
|
2821
1974
|
"type": "array"
|
|
2822
1975
|
},
|
|
2823
1976
|
"tail_consumers": {
|
|
2824
|
-
"default":
|
|
1977
|
+
"default": [],
|
|
2825
1978
|
"description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2826
1979
|
"items": {
|
|
2827
1980
|
"$ref": "#/definitions/TailConsumer"
|
|
@@ -2830,7 +1983,9 @@
|
|
|
2830
1983
|
},
|
|
2831
1984
|
"triggers": {
|
|
2832
1985
|
"additionalProperties": false,
|
|
2833
|
-
"default":
|
|
1986
|
+
"default": {
|
|
1987
|
+
"crons": []
|
|
1988
|
+
},
|
|
2834
1989
|
"description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
|
|
2835
1990
|
"properties": {
|
|
2836
1991
|
"crons": {
|
|
@@ -2851,7 +2006,7 @@
|
|
|
2851
2006
|
},
|
|
2852
2007
|
"unsafe": {
|
|
2853
2008
|
"additionalProperties": false,
|
|
2854
|
-
"default":
|
|
2009
|
+
"default": {},
|
|
2855
2010
|
"description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2856
2011
|
"properties": {
|
|
2857
2012
|
"bindings": {
|
|
@@ -2922,14 +2077,6 @@
|
|
|
2922
2077
|
"description": "Include source maps when uploading this worker.",
|
|
2923
2078
|
"type": "boolean"
|
|
2924
2079
|
},
|
|
2925
|
-
"usage_model": {
|
|
2926
|
-
"description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
|
|
2927
|
-
"enum": [
|
|
2928
|
-
"bundled",
|
|
2929
|
-
"unbound"
|
|
2930
|
-
],
|
|
2931
|
-
"type": "string"
|
|
2932
|
-
},
|
|
2933
2080
|
"vars": {
|
|
2934
2081
|
"additionalProperties": {
|
|
2935
2082
|
"anyOf": [
|
|
@@ -2941,12 +2088,12 @@
|
|
|
2941
2088
|
}
|
|
2942
2089
|
]
|
|
2943
2090
|
},
|
|
2944
|
-
"default":
|
|
2091
|
+
"default": {},
|
|
2945
2092
|
"description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2946
2093
|
"type": "object"
|
|
2947
2094
|
},
|
|
2948
2095
|
"vectorize": {
|
|
2949
|
-
"default":
|
|
2096
|
+
"default": [],
|
|
2950
2097
|
"description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2951
2098
|
"items": {
|
|
2952
2099
|
"additionalProperties": false,
|
|
@@ -2982,13 +2129,17 @@
|
|
|
2982
2129
|
"type": "object"
|
|
2983
2130
|
},
|
|
2984
2131
|
"workers_dev": {
|
|
2985
|
-
"default":
|
|
2986
|
-
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker
|
|
2132
|
+
"default": true,
|
|
2133
|
+
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.",
|
|
2987
2134
|
"type": "boolean"
|
|
2988
2135
|
},
|
|
2989
|
-
"
|
|
2990
|
-
"
|
|
2991
|
-
"
|
|
2136
|
+
"workflows": {
|
|
2137
|
+
"default": [],
|
|
2138
|
+
"description": "A list of workflows that your Worker should be bound to.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
|
2139
|
+
"items": {
|
|
2140
|
+
"$ref": "#/definitions/WorkflowBinding"
|
|
2141
|
+
},
|
|
2142
|
+
"type": "array"
|
|
2992
2143
|
}
|
|
2993
2144
|
},
|
|
2994
2145
|
"type": "object"
|
|
@@ -2996,7 +2147,7 @@
|
|
|
2996
2147
|
"Route": {
|
|
2997
2148
|
"anyOf": [
|
|
2998
2149
|
{
|
|
2999
|
-
"
|
|
2150
|
+
"type": "string"
|
|
3000
2151
|
},
|
|
3001
2152
|
{
|
|
3002
2153
|
"$ref": "#/definitions/ZoneIdRoute"
|
|
@@ -3032,9 +2183,6 @@
|
|
|
3032
2183
|
],
|
|
3033
2184
|
"type": "object"
|
|
3034
2185
|
},
|
|
3035
|
-
"SimpleRoute": {
|
|
3036
|
-
"type": "string"
|
|
3037
|
-
},
|
|
3038
2186
|
"TailConsumer": {
|
|
3039
2187
|
"additionalProperties": false,
|
|
3040
2188
|
"properties": {
|
|
@@ -3073,6 +2221,33 @@
|
|
|
3073
2221
|
],
|
|
3074
2222
|
"type": "object"
|
|
3075
2223
|
},
|
|
2224
|
+
"WorkflowBinding": {
|
|
2225
|
+
"additionalProperties": false,
|
|
2226
|
+
"properties": {
|
|
2227
|
+
"binding": {
|
|
2228
|
+
"description": "The name of the binding used to refer to the Workflow",
|
|
2229
|
+
"type": "string"
|
|
2230
|
+
},
|
|
2231
|
+
"class_name": {
|
|
2232
|
+
"description": "The exported class name of the Workflow",
|
|
2233
|
+
"type": "string"
|
|
2234
|
+
},
|
|
2235
|
+
"name": {
|
|
2236
|
+
"description": "The name of the Workflow",
|
|
2237
|
+
"type": "string"
|
|
2238
|
+
},
|
|
2239
|
+
"script_name": {
|
|
2240
|
+
"description": "The script where the Workflow is defined (if it's external to this Worker)",
|
|
2241
|
+
"type": "string"
|
|
2242
|
+
}
|
|
2243
|
+
},
|
|
2244
|
+
"required": [
|
|
2245
|
+
"binding",
|
|
2246
|
+
"name",
|
|
2247
|
+
"class_name"
|
|
2248
|
+
],
|
|
2249
|
+
"type": "object"
|
|
2250
|
+
},
|
|
3076
2251
|
"ZoneIdRoute": {
|
|
3077
2252
|
"additionalProperties": false,
|
|
3078
2253
|
"properties": {
|