wrangler 0.0.0-e60a675d → 0.0.0-e61444cb
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 +1 -1
- package/bin/wrangler.js +0 -28
- package/config-schema.json +276 -117
- package/package.json +44 -72
- package/templates/checked-fetch.js +1 -1
- package/templates/facade.d.ts +2 -2
- package/templates/gitignore +3 -0
- package/templates/middleware/loader-modules.ts +14 -13
- package/templates/pages-template-plugin.ts +2 -2
- package/templates/pages-template-worker.ts +1 -1
- package/templates/startDevWorker/InspectorProxyWorker.ts +4 -1
- package/templates/startDevWorker/ProxyWorker.ts +4 -1
- package/templates/tsconfig.init.json +4 -87
- package/wrangler-dist/InspectorProxyWorker.js.map +1 -1
- package/wrangler-dist/ProxyWorker.js.map +1 -1
- package/wrangler-dist/cli.d.ts +3029 -622
- package/wrangler-dist/cli.js +50234 -13095
- package/Cloudflare_CA.pem +0 -18
package/config-schema.json
CHANGED
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
"Text",
|
|
25
25
|
"Data",
|
|
26
26
|
"PythonModule",
|
|
27
|
-
"PythonRequirement"
|
|
27
|
+
"PythonRequirement",
|
|
28
|
+
"NodeJsCompatModule"
|
|
28
29
|
],
|
|
29
30
|
"type": "string"
|
|
30
31
|
},
|
|
@@ -50,7 +51,7 @@
|
|
|
50
51
|
"properties": {
|
|
51
52
|
"dir": {
|
|
52
53
|
"deprecated": true,
|
|
53
|
-
"description": "The directory you wish to upload your
|
|
54
|
+
"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.",
|
|
54
55
|
"type": "string"
|
|
55
56
|
},
|
|
56
57
|
"format": {
|
|
@@ -82,7 +83,7 @@
|
|
|
82
83
|
"type": "string"
|
|
83
84
|
},
|
|
84
85
|
"parameters": {
|
|
85
|
-
"description": "(Optional) List of parameter names, for sending context from your dispatch
|
|
86
|
+
"description": "(Optional) List of parameter names, for sending context from your dispatch Worker to the outbound handler",
|
|
86
87
|
"items": {
|
|
87
88
|
"type": "string"
|
|
88
89
|
},
|
|
@@ -115,7 +116,7 @@
|
|
|
115
116
|
"type": "string"
|
|
116
117
|
},
|
|
117
118
|
"script_name": {
|
|
118
|
-
"description": "The script where the Durable Object is defined (if it's external to this
|
|
119
|
+
"description": "The script where the Durable Object is defined (if it's external to this Worker)",
|
|
119
120
|
"type": "string"
|
|
120
121
|
}
|
|
121
122
|
},
|
|
@@ -137,10 +138,14 @@
|
|
|
137
138
|
},
|
|
138
139
|
"ai": {
|
|
139
140
|
"additionalProperties": false,
|
|
140
|
-
"
|
|
141
|
+
"default": "`{}`",
|
|
142
|
+
"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.",
|
|
141
143
|
"properties": {
|
|
142
144
|
"binding": {
|
|
143
145
|
"type": "string"
|
|
146
|
+
},
|
|
147
|
+
"staging": {
|
|
148
|
+
"type": "boolean"
|
|
144
149
|
}
|
|
145
150
|
},
|
|
146
151
|
"required": [
|
|
@@ -155,7 +160,7 @@
|
|
|
155
160
|
"additionalProperties": false,
|
|
156
161
|
"properties": {
|
|
157
162
|
"binding": {
|
|
158
|
-
"description": "The binding name used to refer to the dataset in the
|
|
163
|
+
"description": "The binding name used to refer to the dataset in the Worker.",
|
|
159
164
|
"type": "string"
|
|
160
165
|
},
|
|
161
166
|
"dataset": {
|
|
@@ -171,12 +176,13 @@
|
|
|
171
176
|
"type": "array"
|
|
172
177
|
},
|
|
173
178
|
"base_dir": {
|
|
174
|
-
"description": "The directory in which module rules should be evaluated when including additional files into a
|
|
179
|
+
"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.",
|
|
175
180
|
"type": "string"
|
|
176
181
|
},
|
|
177
182
|
"browser": {
|
|
178
183
|
"additionalProperties": false,
|
|
179
|
-
"
|
|
184
|
+
"default": "`{}`",
|
|
185
|
+
"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.",
|
|
180
186
|
"properties": {
|
|
181
187
|
"binding": {
|
|
182
188
|
"type": "string"
|
|
@@ -189,7 +195,9 @@
|
|
|
189
195
|
},
|
|
190
196
|
"build": {
|
|
191
197
|
"additionalProperties": false,
|
|
192
|
-
"default": {
|
|
198
|
+
"default": {
|
|
199
|
+
"watch_dir": "./src"
|
|
200
|
+
},
|
|
193
201
|
"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.",
|
|
194
202
|
"properties": {
|
|
195
203
|
"command": {
|
|
@@ -232,6 +240,7 @@
|
|
|
232
240
|
"type": "string"
|
|
233
241
|
},
|
|
234
242
|
"compatibility_flags": {
|
|
243
|
+
"default": "`[]`",
|
|
235
244
|
"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",
|
|
236
245
|
"items": {
|
|
237
246
|
"type": "string"
|
|
@@ -245,7 +254,7 @@
|
|
|
245
254
|
"additionalProperties": false,
|
|
246
255
|
"properties": {
|
|
247
256
|
"binding": {
|
|
248
|
-
"description": "The binding name used to refer to the project in the
|
|
257
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
|
249
258
|
"type": "string"
|
|
250
259
|
},
|
|
251
260
|
"project_id": {
|
|
@@ -268,7 +277,7 @@
|
|
|
268
277
|
"additionalProperties": false,
|
|
269
278
|
"properties": {
|
|
270
279
|
"binding": {
|
|
271
|
-
"description": "The binding name used to refer to the D1 database in the
|
|
280
|
+
"description": "The binding name used to refer to the D1 database in the Worker.",
|
|
272
281
|
"type": "string"
|
|
273
282
|
},
|
|
274
283
|
"database_id": {
|
|
@@ -310,7 +319,7 @@
|
|
|
310
319
|
"type": "string"
|
|
311
320
|
},
|
|
312
321
|
"default": "`{}`",
|
|
313
|
-
"description": "A map of values to substitute when deploying your
|
|
322
|
+
"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.",
|
|
314
323
|
"type": "object"
|
|
315
324
|
},
|
|
316
325
|
"dispatch_namespaces": {
|
|
@@ -329,7 +338,7 @@
|
|
|
329
338
|
},
|
|
330
339
|
"outbound": {
|
|
331
340
|
"$ref": "#/definitions/DispatchNamespaceOutbound",
|
|
332
|
-
"description": "Details about the outbound
|
|
341
|
+
"description": "Details about the outbound Worker which will handle outbound requests from your namespace"
|
|
333
342
|
}
|
|
334
343
|
},
|
|
335
344
|
"required": [
|
|
@@ -343,7 +352,7 @@
|
|
|
343
352
|
"durable_objects": {
|
|
344
353
|
"additionalProperties": false,
|
|
345
354
|
"default": "`{bindings:[]}`",
|
|
346
|
-
"description": "A list of durable objects that your
|
|
355
|
+
"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.",
|
|
347
356
|
"properties": {
|
|
348
357
|
"bindings": {
|
|
349
358
|
"$ref": "#/definitions/DurableObjectBindings"
|
|
@@ -355,11 +364,11 @@
|
|
|
355
364
|
"type": "object"
|
|
356
365
|
},
|
|
357
366
|
"find_additional_modules": {
|
|
358
|
-
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed
|
|
367
|
+
"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.",
|
|
359
368
|
"type": "boolean"
|
|
360
369
|
},
|
|
361
370
|
"first_party_worker": {
|
|
362
|
-
"description": "Designates this
|
|
371
|
+
"description": "Designates this Worker as an internal-only \"first-party\" Worker.",
|
|
363
372
|
"type": "boolean"
|
|
364
373
|
},
|
|
365
374
|
"hyperdrive": {
|
|
@@ -369,7 +378,7 @@
|
|
|
369
378
|
"additionalProperties": false,
|
|
370
379
|
"properties": {
|
|
371
380
|
"binding": {
|
|
372
|
-
"description": "The binding name used to refer to the project in the
|
|
381
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
|
373
382
|
"type": "string"
|
|
374
383
|
},
|
|
375
384
|
"id": {
|
|
@@ -463,23 +472,77 @@
|
|
|
463
472
|
"type": "object"
|
|
464
473
|
},
|
|
465
474
|
"logpush": {
|
|
466
|
-
"description": "Send Trace Events from this
|
|
475
|
+
"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/",
|
|
467
476
|
"type": "boolean"
|
|
468
477
|
},
|
|
469
478
|
"main": {
|
|
470
479
|
"description": "The entrypoint/path to the JavaScript file that will be executed.",
|
|
471
480
|
"type": "string"
|
|
472
481
|
},
|
|
482
|
+
"migrations": {
|
|
483
|
+
"default": [],
|
|
484
|
+
"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",
|
|
485
|
+
"items": {
|
|
486
|
+
"additionalProperties": false,
|
|
487
|
+
"properties": {
|
|
488
|
+
"deleted_classes": {
|
|
489
|
+
"description": "The Durable Objects being removed.",
|
|
490
|
+
"items": {
|
|
491
|
+
"type": "string"
|
|
492
|
+
},
|
|
493
|
+
"type": "array"
|
|
494
|
+
},
|
|
495
|
+
"new_classes": {
|
|
496
|
+
"description": "The new Durable Objects being defined.",
|
|
497
|
+
"items": {
|
|
498
|
+
"type": "string"
|
|
499
|
+
},
|
|
500
|
+
"type": "array"
|
|
501
|
+
},
|
|
502
|
+
"renamed_classes": {
|
|
503
|
+
"description": "The Durable Objects being renamed.",
|
|
504
|
+
"items": {
|
|
505
|
+
"additionalProperties": false,
|
|
506
|
+
"properties": {
|
|
507
|
+
"from": {
|
|
508
|
+
"type": "string"
|
|
509
|
+
},
|
|
510
|
+
"to": {
|
|
511
|
+
"type": "string"
|
|
512
|
+
}
|
|
513
|
+
},
|
|
514
|
+
"required": [
|
|
515
|
+
"from",
|
|
516
|
+
"to"
|
|
517
|
+
],
|
|
518
|
+
"type": "object"
|
|
519
|
+
},
|
|
520
|
+
"type": "array"
|
|
521
|
+
},
|
|
522
|
+
"tag": {
|
|
523
|
+
"description": "A unique identifier for this migration.",
|
|
524
|
+
"type": "string"
|
|
525
|
+
}
|
|
526
|
+
},
|
|
527
|
+
"required": [
|
|
528
|
+
"tag"
|
|
529
|
+
],
|
|
530
|
+
"type": "object"
|
|
531
|
+
},
|
|
532
|
+
"type": "array"
|
|
533
|
+
},
|
|
473
534
|
"minify": {
|
|
474
535
|
"description": "Minify the script before uploading.",
|
|
475
536
|
"type": "boolean"
|
|
476
537
|
},
|
|
477
538
|
"mtls_certificates": {
|
|
539
|
+
"default": "`[]`",
|
|
540
|
+
"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.",
|
|
478
541
|
"items": {
|
|
479
542
|
"additionalProperties": false,
|
|
480
543
|
"properties": {
|
|
481
544
|
"binding": {
|
|
482
|
-
"description": "The binding name used to refer to the certificate in the
|
|
545
|
+
"description": "The binding name used to refer to the certificate in the Worker",
|
|
483
546
|
"type": "string"
|
|
484
547
|
},
|
|
485
548
|
"certificate_id": {
|
|
@@ -496,7 +559,7 @@
|
|
|
496
559
|
"type": "array"
|
|
497
560
|
},
|
|
498
561
|
"name": {
|
|
499
|
-
"description": "The name of your
|
|
562
|
+
"description": "The name of your Worker. Alphanumeric + dashes only.",
|
|
500
563
|
"type": "string"
|
|
501
564
|
},
|
|
502
565
|
"no_bundle": {
|
|
@@ -509,7 +572,7 @@
|
|
|
509
572
|
},
|
|
510
573
|
"placement": {
|
|
511
574
|
"additionalProperties": false,
|
|
512
|
-
"description": "Specify how the
|
|
575
|
+
"description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
|
|
513
576
|
"properties": {
|
|
514
577
|
"mode": {
|
|
515
578
|
"enum": [
|
|
@@ -530,7 +593,7 @@
|
|
|
530
593
|
},
|
|
531
594
|
"queues": {
|
|
532
595
|
"additionalProperties": false,
|
|
533
|
-
"default": "`{}`",
|
|
596
|
+
"default": "`{consumers:[],producers:[]}`",
|
|
534
597
|
"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.",
|
|
535
598
|
"properties": {
|
|
536
599
|
"consumers": {
|
|
@@ -591,7 +654,7 @@
|
|
|
591
654
|
"additionalProperties": false,
|
|
592
655
|
"properties": {
|
|
593
656
|
"binding": {
|
|
594
|
-
"description": "The binding name used to refer to the Queue in the
|
|
657
|
+
"description": "The binding name used to refer to the Queue in the Worker.",
|
|
595
658
|
"type": "string"
|
|
596
659
|
},
|
|
597
660
|
"delivery_delay": {
|
|
@@ -621,7 +684,7 @@
|
|
|
621
684
|
"additionalProperties": false,
|
|
622
685
|
"properties": {
|
|
623
686
|
"binding": {
|
|
624
|
-
"description": "The binding name used to refer to the R2 bucket in the
|
|
687
|
+
"description": "The binding name used to refer to the R2 bucket in the Worker.",
|
|
625
688
|
"type": "string"
|
|
626
689
|
},
|
|
627
690
|
"bucket_name": {
|
|
@@ -647,10 +710,10 @@
|
|
|
647
710
|
},
|
|
648
711
|
"route": {
|
|
649
712
|
"$ref": "#/definitions/Route",
|
|
650
|
-
"description": "A route that your
|
|
713
|
+
"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"
|
|
651
714
|
},
|
|
652
715
|
"routes": {
|
|
653
|
-
"description": "A list of routes that your
|
|
716
|
+
"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`)",
|
|
654
717
|
"items": {
|
|
655
718
|
"$ref": "#/definitions/Route"
|
|
656
719
|
},
|
|
@@ -694,7 +757,7 @@
|
|
|
694
757
|
},
|
|
695
758
|
"services": {
|
|
696
759
|
"default": "`[]`",
|
|
697
|
-
"description": "Specifies service bindings (
|
|
760
|
+
"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.",
|
|
698
761
|
"items": {
|
|
699
762
|
"additionalProperties": false,
|
|
700
763
|
"properties": {
|
|
@@ -724,6 +787,8 @@
|
|
|
724
787
|
"type": "array"
|
|
725
788
|
},
|
|
726
789
|
"tail_consumers": {
|
|
790
|
+
"default": "`[]`",
|
|
791
|
+
"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.",
|
|
727
792
|
"items": {
|
|
728
793
|
"$ref": "#/definitions/TailConsumer"
|
|
729
794
|
},
|
|
@@ -732,7 +797,7 @@
|
|
|
732
797
|
"triggers": {
|
|
733
798
|
"additionalProperties": false,
|
|
734
799
|
"default": "`{crons:[]}`",
|
|
735
|
-
"description": "\"Cron\" definitions to trigger a
|
|
800
|
+
"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",
|
|
736
801
|
"properties": {
|
|
737
802
|
"crons": {
|
|
738
803
|
"items": {
|
|
@@ -752,6 +817,7 @@
|
|
|
752
817
|
},
|
|
753
818
|
"unsafe": {
|
|
754
819
|
"additionalProperties": false,
|
|
820
|
+
"default": "`{}`",
|
|
755
821
|
"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.",
|
|
756
822
|
"properties": {
|
|
757
823
|
"bindings": {
|
|
@@ -842,7 +908,7 @@
|
|
|
842
908
|
]
|
|
843
909
|
},
|
|
844
910
|
"default": "`{}`",
|
|
845
|
-
"description": "A map of environment variables to set when deploying your
|
|
911
|
+
"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.",
|
|
846
912
|
"type": "object"
|
|
847
913
|
},
|
|
848
914
|
"vectorize": {
|
|
@@ -852,7 +918,7 @@
|
|
|
852
918
|
"additionalProperties": false,
|
|
853
919
|
"properties": {
|
|
854
920
|
"binding": {
|
|
855
|
-
"description": "The binding name used to refer to the Vectorize index in the
|
|
921
|
+
"description": "The binding name used to refer to the Vectorize index in the Worker.",
|
|
856
922
|
"type": "string"
|
|
857
923
|
},
|
|
858
924
|
"index_name": {
|
|
@@ -883,7 +949,7 @@
|
|
|
883
949
|
},
|
|
884
950
|
"workers_dev": {
|
|
885
951
|
"default": "`true` (This is a breaking change from Wrangler v1)",
|
|
886
|
-
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your
|
|
952
|
+
"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",
|
|
887
953
|
"type": "boolean"
|
|
888
954
|
},
|
|
889
955
|
"zone_id": {
|
|
@@ -906,6 +972,7 @@
|
|
|
906
972
|
"jsx_fragment",
|
|
907
973
|
"kv_namespaces",
|
|
908
974
|
"logfwdr",
|
|
975
|
+
"migrations",
|
|
909
976
|
"mtls_certificates",
|
|
910
977
|
"queues",
|
|
911
978
|
"r2_buckets",
|
|
@@ -952,10 +1019,14 @@
|
|
|
952
1019
|
},
|
|
953
1020
|
"ai": {
|
|
954
1021
|
"additionalProperties": false,
|
|
955
|
-
"
|
|
1022
|
+
"default": "`{}`",
|
|
1023
|
+
"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.",
|
|
956
1024
|
"properties": {
|
|
957
1025
|
"binding": {
|
|
958
1026
|
"type": "string"
|
|
1027
|
+
},
|
|
1028
|
+
"staging": {
|
|
1029
|
+
"type": "boolean"
|
|
959
1030
|
}
|
|
960
1031
|
},
|
|
961
1032
|
"required": [
|
|
@@ -963,6 +1034,13 @@
|
|
|
963
1034
|
],
|
|
964
1035
|
"type": "object"
|
|
965
1036
|
},
|
|
1037
|
+
"alias": {
|
|
1038
|
+
"additionalProperties": {
|
|
1039
|
+
"type": "string"
|
|
1040
|
+
},
|
|
1041
|
+
"description": "A map of module aliases. Lets you swap out a module for any others. Corresponds with esbuild's `alias` config",
|
|
1042
|
+
"type": "object"
|
|
1043
|
+
},
|
|
966
1044
|
"analytics_engine_datasets": {
|
|
967
1045
|
"default": "`[]`",
|
|
968
1046
|
"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.",
|
|
@@ -970,7 +1048,7 @@
|
|
|
970
1048
|
"additionalProperties": false,
|
|
971
1049
|
"properties": {
|
|
972
1050
|
"binding": {
|
|
973
|
-
"description": "The binding name used to refer to the dataset in the
|
|
1051
|
+
"description": "The binding name used to refer to the dataset in the Worker.",
|
|
974
1052
|
"type": "string"
|
|
975
1053
|
},
|
|
976
1054
|
"dataset": {
|
|
@@ -986,46 +1064,54 @@
|
|
|
986
1064
|
"type": "array"
|
|
987
1065
|
},
|
|
988
1066
|
"assets": {
|
|
989
|
-
"
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1067
|
+
"anyOf": [
|
|
1068
|
+
{
|
|
1069
|
+
"additionalProperties": false,
|
|
1070
|
+
"properties": {
|
|
1071
|
+
"browser_TTL": {
|
|
1072
|
+
"type": "number"
|
|
1073
|
+
},
|
|
1074
|
+
"bucket": {
|
|
1075
|
+
"type": "string"
|
|
1076
|
+
},
|
|
1077
|
+
"exclude": {
|
|
1078
|
+
"items": {
|
|
1079
|
+
"type": "string"
|
|
1080
|
+
},
|
|
1081
|
+
"type": "array"
|
|
1082
|
+
},
|
|
1083
|
+
"include": {
|
|
1084
|
+
"items": {
|
|
1085
|
+
"type": "string"
|
|
1086
|
+
},
|
|
1087
|
+
"type": "array"
|
|
1088
|
+
},
|
|
1089
|
+
"serve_single_page_app": {
|
|
1090
|
+
"type": "boolean"
|
|
1091
|
+
}
|
|
1007
1092
|
},
|
|
1008
|
-
"
|
|
1093
|
+
"required": [
|
|
1094
|
+
"bucket",
|
|
1095
|
+
"include",
|
|
1096
|
+
"exclude",
|
|
1097
|
+
"serve_single_page_app"
|
|
1098
|
+
],
|
|
1099
|
+
"type": "object"
|
|
1009
1100
|
},
|
|
1010
|
-
|
|
1011
|
-
"type": "
|
|
1101
|
+
{
|
|
1102
|
+
"type": "string"
|
|
1012
1103
|
}
|
|
1013
|
-
},
|
|
1014
|
-
"required": [
|
|
1015
|
-
"bucket",
|
|
1016
|
-
"include",
|
|
1017
|
-
"exclude",
|
|
1018
|
-
"serve_single_page_app"
|
|
1019
1104
|
],
|
|
1020
|
-
"
|
|
1105
|
+
"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."
|
|
1021
1106
|
},
|
|
1022
1107
|
"base_dir": {
|
|
1023
|
-
"description": "The directory in which module rules should be evaluated when including additional files into a
|
|
1108
|
+
"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.",
|
|
1024
1109
|
"type": "string"
|
|
1025
1110
|
},
|
|
1026
1111
|
"browser": {
|
|
1027
1112
|
"additionalProperties": false,
|
|
1028
|
-
"
|
|
1113
|
+
"default": "`{}`",
|
|
1114
|
+
"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.",
|
|
1029
1115
|
"properties": {
|
|
1030
1116
|
"binding": {
|
|
1031
1117
|
"type": "string"
|
|
@@ -1038,7 +1124,9 @@
|
|
|
1038
1124
|
},
|
|
1039
1125
|
"build": {
|
|
1040
1126
|
"additionalProperties": false,
|
|
1041
|
-
"default": {
|
|
1127
|
+
"default": {
|
|
1128
|
+
"watch_dir": "./src"
|
|
1129
|
+
},
|
|
1042
1130
|
"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.",
|
|
1043
1131
|
"properties": {
|
|
1044
1132
|
"command": {
|
|
@@ -1081,6 +1169,7 @@
|
|
|
1081
1169
|
"type": "string"
|
|
1082
1170
|
},
|
|
1083
1171
|
"compatibility_flags": {
|
|
1172
|
+
"default": "`[]`",
|
|
1084
1173
|
"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",
|
|
1085
1174
|
"items": {
|
|
1086
1175
|
"type": "string"
|
|
@@ -1097,7 +1186,7 @@
|
|
|
1097
1186
|
"additionalProperties": false,
|
|
1098
1187
|
"properties": {
|
|
1099
1188
|
"binding": {
|
|
1100
|
-
"description": "The binding name used to refer to the project in the
|
|
1189
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
|
1101
1190
|
"type": "string"
|
|
1102
1191
|
},
|
|
1103
1192
|
"project_id": {
|
|
@@ -1120,7 +1209,7 @@
|
|
|
1120
1209
|
"additionalProperties": false,
|
|
1121
1210
|
"properties": {
|
|
1122
1211
|
"binding": {
|
|
1123
|
-
"description": "The binding name used to refer to the D1 database in the
|
|
1212
|
+
"description": "The binding name used to refer to the D1 database in the Worker.",
|
|
1124
1213
|
"type": "string"
|
|
1125
1214
|
},
|
|
1126
1215
|
"database_id": {
|
|
@@ -1169,7 +1258,7 @@
|
|
|
1169
1258
|
"type": "string"
|
|
1170
1259
|
},
|
|
1171
1260
|
"default": "`{}`",
|
|
1172
|
-
"description": "A map of values to substitute when deploying your
|
|
1261
|
+
"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.",
|
|
1173
1262
|
"type": "object"
|
|
1174
1263
|
},
|
|
1175
1264
|
"dev": {
|
|
@@ -1192,7 +1281,7 @@
|
|
|
1192
1281
|
},
|
|
1193
1282
|
"outbound": {
|
|
1194
1283
|
"$ref": "#/definitions/DispatchNamespaceOutbound",
|
|
1195
|
-
"description": "Details about the outbound
|
|
1284
|
+
"description": "Details about the outbound Worker which will handle outbound requests from your namespace"
|
|
1196
1285
|
}
|
|
1197
1286
|
},
|
|
1198
1287
|
"required": [
|
|
@@ -1206,7 +1295,7 @@
|
|
|
1206
1295
|
"durable_objects": {
|
|
1207
1296
|
"additionalProperties": false,
|
|
1208
1297
|
"default": "`{bindings:[]}`",
|
|
1209
|
-
"description": "A list of durable objects that your
|
|
1298
|
+
"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.",
|
|
1210
1299
|
"properties": {
|
|
1211
1300
|
"bindings": {
|
|
1212
1301
|
"$ref": "#/definitions/DurableObjectBindings"
|
|
@@ -1228,7 +1317,7 @@
|
|
|
1228
1317
|
"experimental_services": {
|
|
1229
1318
|
"default": "`[]`",
|
|
1230
1319
|
"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.",
|
|
1231
|
-
"description": "A list of services that your
|
|
1320
|
+
"description": "A list of services that your Worker should be bound to.",
|
|
1232
1321
|
"items": {
|
|
1233
1322
|
"additionalProperties": false,
|
|
1234
1323
|
"properties": {
|
|
@@ -1255,11 +1344,11 @@
|
|
|
1255
1344
|
"type": "array"
|
|
1256
1345
|
},
|
|
1257
1346
|
"find_additional_modules": {
|
|
1258
|
-
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed
|
|
1347
|
+
"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.",
|
|
1259
1348
|
"type": "boolean"
|
|
1260
1349
|
},
|
|
1261
1350
|
"first_party_worker": {
|
|
1262
|
-
"description": "Designates this
|
|
1351
|
+
"description": "Designates this Worker as an internal-only \"first-party\" Worker.",
|
|
1263
1352
|
"type": "boolean"
|
|
1264
1353
|
},
|
|
1265
1354
|
"hyperdrive": {
|
|
@@ -1269,7 +1358,7 @@
|
|
|
1269
1358
|
"additionalProperties": false,
|
|
1270
1359
|
"properties": {
|
|
1271
1360
|
"binding": {
|
|
1272
|
-
"description": "The binding name used to refer to the project in the
|
|
1361
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
|
1273
1362
|
"type": "string"
|
|
1274
1363
|
},
|
|
1275
1364
|
"id": {
|
|
@@ -1377,7 +1466,7 @@
|
|
|
1377
1466
|
"type": "object"
|
|
1378
1467
|
},
|
|
1379
1468
|
"logpush": {
|
|
1380
|
-
"description": "Send Trace Events from this
|
|
1469
|
+
"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/",
|
|
1381
1470
|
"type": "boolean"
|
|
1382
1471
|
},
|
|
1383
1472
|
"main": {
|
|
@@ -1445,11 +1534,13 @@
|
|
|
1445
1534
|
"type": "boolean"
|
|
1446
1535
|
},
|
|
1447
1536
|
"mtls_certificates": {
|
|
1537
|
+
"default": "`[]`",
|
|
1538
|
+
"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.",
|
|
1448
1539
|
"items": {
|
|
1449
1540
|
"additionalProperties": false,
|
|
1450
1541
|
"properties": {
|
|
1451
1542
|
"binding": {
|
|
1452
|
-
"description": "The binding name used to refer to the certificate in the
|
|
1543
|
+
"description": "The binding name used to refer to the certificate in the Worker",
|
|
1453
1544
|
"type": "string"
|
|
1454
1545
|
},
|
|
1455
1546
|
"certificate_id": {
|
|
@@ -1466,7 +1557,7 @@
|
|
|
1466
1557
|
"type": "array"
|
|
1467
1558
|
},
|
|
1468
1559
|
"name": {
|
|
1469
|
-
"description": "The name of your
|
|
1560
|
+
"description": "The name of your Worker. Alphanumeric + dashes only.",
|
|
1470
1561
|
"type": "string"
|
|
1471
1562
|
},
|
|
1472
1563
|
"no_bundle": {
|
|
@@ -1483,7 +1574,7 @@
|
|
|
1483
1574
|
},
|
|
1484
1575
|
"placement": {
|
|
1485
1576
|
"additionalProperties": false,
|
|
1486
|
-
"description": "Specify how the
|
|
1577
|
+
"description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
|
|
1487
1578
|
"properties": {
|
|
1488
1579
|
"mode": {
|
|
1489
1580
|
"enum": [
|
|
@@ -1504,7 +1595,7 @@
|
|
|
1504
1595
|
},
|
|
1505
1596
|
"queues": {
|
|
1506
1597
|
"additionalProperties": false,
|
|
1507
|
-
"default": "`{}`",
|
|
1598
|
+
"default": "`{consumers:[],producers:[]}`",
|
|
1508
1599
|
"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.",
|
|
1509
1600
|
"properties": {
|
|
1510
1601
|
"consumers": {
|
|
@@ -1565,7 +1656,7 @@
|
|
|
1565
1656
|
"additionalProperties": false,
|
|
1566
1657
|
"properties": {
|
|
1567
1658
|
"binding": {
|
|
1568
|
-
"description": "The binding name used to refer to the Queue in the
|
|
1659
|
+
"description": "The binding name used to refer to the Queue in the Worker.",
|
|
1569
1660
|
"type": "string"
|
|
1570
1661
|
},
|
|
1571
1662
|
"delivery_delay": {
|
|
@@ -1595,7 +1686,7 @@
|
|
|
1595
1686
|
"additionalProperties": false,
|
|
1596
1687
|
"properties": {
|
|
1597
1688
|
"binding": {
|
|
1598
|
-
"description": "The binding name used to refer to the R2 bucket in the
|
|
1689
|
+
"description": "The binding name used to refer to the R2 bucket in the Worker.",
|
|
1599
1690
|
"type": "string"
|
|
1600
1691
|
},
|
|
1601
1692
|
"bucket_name": {
|
|
@@ -1621,10 +1712,10 @@
|
|
|
1621
1712
|
},
|
|
1622
1713
|
"route": {
|
|
1623
1714
|
"$ref": "#/definitions/Route",
|
|
1624
|
-
"description": "A route that your
|
|
1715
|
+
"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"
|
|
1625
1716
|
},
|
|
1626
1717
|
"routes": {
|
|
1627
|
-
"description": "A list of routes that your
|
|
1718
|
+
"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`)",
|
|
1628
1719
|
"items": {
|
|
1629
1720
|
"$ref": "#/definitions/Route"
|
|
1630
1721
|
},
|
|
@@ -1672,7 +1763,7 @@
|
|
|
1672
1763
|
},
|
|
1673
1764
|
"services": {
|
|
1674
1765
|
"default": "`[]`",
|
|
1675
|
-
"description": "Specifies service bindings (
|
|
1766
|
+
"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.",
|
|
1676
1767
|
"items": {
|
|
1677
1768
|
"additionalProperties": false,
|
|
1678
1769
|
"properties": {
|
|
@@ -1737,6 +1828,8 @@
|
|
|
1737
1828
|
"type": "object"
|
|
1738
1829
|
},
|
|
1739
1830
|
"tail_consumers": {
|
|
1831
|
+
"default": "`[]`",
|
|
1832
|
+
"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.",
|
|
1740
1833
|
"items": {
|
|
1741
1834
|
"$ref": "#/definitions/TailConsumer"
|
|
1742
1835
|
},
|
|
@@ -1752,7 +1845,7 @@
|
|
|
1752
1845
|
"triggers": {
|
|
1753
1846
|
"additionalProperties": false,
|
|
1754
1847
|
"default": "`{crons:[]}`",
|
|
1755
|
-
"description": "\"Cron\" definitions to trigger a
|
|
1848
|
+
"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",
|
|
1756
1849
|
"properties": {
|
|
1757
1850
|
"crons": {
|
|
1758
1851
|
"items": {
|
|
@@ -1782,6 +1875,7 @@
|
|
|
1782
1875
|
},
|
|
1783
1876
|
"unsafe": {
|
|
1784
1877
|
"additionalProperties": false,
|
|
1878
|
+
"default": "`{}`",
|
|
1785
1879
|
"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.",
|
|
1786
1880
|
"properties": {
|
|
1787
1881
|
"bindings": {
|
|
@@ -1872,7 +1966,7 @@
|
|
|
1872
1966
|
]
|
|
1873
1967
|
},
|
|
1874
1968
|
"default": "`{}`",
|
|
1875
|
-
"description": "A map of environment variables to set when deploying your
|
|
1969
|
+
"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.",
|
|
1876
1970
|
"type": "object"
|
|
1877
1971
|
},
|
|
1878
1972
|
"vectorize": {
|
|
@@ -1882,7 +1976,7 @@
|
|
|
1882
1976
|
"additionalProperties": false,
|
|
1883
1977
|
"properties": {
|
|
1884
1978
|
"binding": {
|
|
1885
|
-
"description": "The binding name used to refer to the Vectorize index in the
|
|
1979
|
+
"description": "The binding name used to refer to the Vectorize index in the Worker.",
|
|
1886
1980
|
"type": "string"
|
|
1887
1981
|
},
|
|
1888
1982
|
"index_name": {
|
|
@@ -1925,7 +2019,7 @@
|
|
|
1925
2019
|
},
|
|
1926
2020
|
"workers_dev": {
|
|
1927
2021
|
"default": "`true` (This is a breaking change from Wrangler v1)",
|
|
1928
|
-
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your
|
|
2022
|
+
"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",
|
|
1929
2023
|
"type": "boolean"
|
|
1930
2024
|
},
|
|
1931
2025
|
"zone_id": {
|
|
@@ -1988,10 +2082,14 @@
|
|
|
1988
2082
|
},
|
|
1989
2083
|
"ai": {
|
|
1990
2084
|
"additionalProperties": false,
|
|
1991
|
-
"
|
|
2085
|
+
"default": "`{}`",
|
|
2086
|
+
"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.",
|
|
1992
2087
|
"properties": {
|
|
1993
2088
|
"binding": {
|
|
1994
2089
|
"type": "string"
|
|
2090
|
+
},
|
|
2091
|
+
"staging": {
|
|
2092
|
+
"type": "boolean"
|
|
1995
2093
|
}
|
|
1996
2094
|
},
|
|
1997
2095
|
"required": [
|
|
@@ -2006,7 +2104,7 @@
|
|
|
2006
2104
|
"additionalProperties": false,
|
|
2007
2105
|
"properties": {
|
|
2008
2106
|
"binding": {
|
|
2009
|
-
"description": "The binding name used to refer to the dataset in the
|
|
2107
|
+
"description": "The binding name used to refer to the dataset in the Worker.",
|
|
2010
2108
|
"type": "string"
|
|
2011
2109
|
},
|
|
2012
2110
|
"dataset": {
|
|
@@ -2022,12 +2120,13 @@
|
|
|
2022
2120
|
"type": "array"
|
|
2023
2121
|
},
|
|
2024
2122
|
"base_dir": {
|
|
2025
|
-
"description": "The directory in which module rules should be evaluated when including additional files into a
|
|
2123
|
+
"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.",
|
|
2026
2124
|
"type": "string"
|
|
2027
2125
|
},
|
|
2028
2126
|
"browser": {
|
|
2029
2127
|
"additionalProperties": false,
|
|
2030
|
-
"
|
|
2128
|
+
"default": "`{}`",
|
|
2129
|
+
"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.",
|
|
2031
2130
|
"properties": {
|
|
2032
2131
|
"binding": {
|
|
2033
2132
|
"type": "string"
|
|
@@ -2040,7 +2139,9 @@
|
|
|
2040
2139
|
},
|
|
2041
2140
|
"build": {
|
|
2042
2141
|
"additionalProperties": false,
|
|
2043
|
-
"default": {
|
|
2142
|
+
"default": {
|
|
2143
|
+
"watch_dir": "./src"
|
|
2144
|
+
},
|
|
2044
2145
|
"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.",
|
|
2045
2146
|
"properties": {
|
|
2046
2147
|
"command": {
|
|
@@ -2083,6 +2184,7 @@
|
|
|
2083
2184
|
"type": "string"
|
|
2084
2185
|
},
|
|
2085
2186
|
"compatibility_flags": {
|
|
2187
|
+
"default": "`[]`",
|
|
2086
2188
|
"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",
|
|
2087
2189
|
"items": {
|
|
2088
2190
|
"type": "string"
|
|
@@ -2096,7 +2198,7 @@
|
|
|
2096
2198
|
"additionalProperties": false,
|
|
2097
2199
|
"properties": {
|
|
2098
2200
|
"binding": {
|
|
2099
|
-
"description": "The binding name used to refer to the project in the
|
|
2201
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
|
2100
2202
|
"type": "string"
|
|
2101
2203
|
},
|
|
2102
2204
|
"project_id": {
|
|
@@ -2119,7 +2221,7 @@
|
|
|
2119
2221
|
"additionalProperties": false,
|
|
2120
2222
|
"properties": {
|
|
2121
2223
|
"binding": {
|
|
2122
|
-
"description": "The binding name used to refer to the D1 database in the
|
|
2224
|
+
"description": "The binding name used to refer to the D1 database in the Worker.",
|
|
2123
2225
|
"type": "string"
|
|
2124
2226
|
},
|
|
2125
2227
|
"database_id": {
|
|
@@ -2161,7 +2263,7 @@
|
|
|
2161
2263
|
"type": "string"
|
|
2162
2264
|
},
|
|
2163
2265
|
"default": "`{}`",
|
|
2164
|
-
"description": "A map of values to substitute when deploying your
|
|
2266
|
+
"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.",
|
|
2165
2267
|
"type": "object"
|
|
2166
2268
|
},
|
|
2167
2269
|
"dispatch_namespaces": {
|
|
@@ -2180,7 +2282,7 @@
|
|
|
2180
2282
|
},
|
|
2181
2283
|
"outbound": {
|
|
2182
2284
|
"$ref": "#/definitions/DispatchNamespaceOutbound",
|
|
2183
|
-
"description": "Details about the outbound
|
|
2285
|
+
"description": "Details about the outbound Worker which will handle outbound requests from your namespace"
|
|
2184
2286
|
}
|
|
2185
2287
|
},
|
|
2186
2288
|
"required": [
|
|
@@ -2194,7 +2296,7 @@
|
|
|
2194
2296
|
"durable_objects": {
|
|
2195
2297
|
"additionalProperties": false,
|
|
2196
2298
|
"default": "`{bindings:[]}`",
|
|
2197
|
-
"description": "A list of durable objects that your
|
|
2299
|
+
"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.",
|
|
2198
2300
|
"properties": {
|
|
2199
2301
|
"bindings": {
|
|
2200
2302
|
"$ref": "#/definitions/DurableObjectBindings"
|
|
@@ -2208,7 +2310,7 @@
|
|
|
2208
2310
|
"experimental_services": {
|
|
2209
2311
|
"default": "`[]`",
|
|
2210
2312
|
"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.",
|
|
2211
|
-
"description": "A list of services that your
|
|
2313
|
+
"description": "A list of services that your Worker should be bound to.",
|
|
2212
2314
|
"items": {
|
|
2213
2315
|
"additionalProperties": false,
|
|
2214
2316
|
"properties": {
|
|
@@ -2235,11 +2337,11 @@
|
|
|
2235
2337
|
"type": "array"
|
|
2236
2338
|
},
|
|
2237
2339
|
"find_additional_modules": {
|
|
2238
|
-
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed
|
|
2340
|
+
"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.",
|
|
2239
2341
|
"type": "boolean"
|
|
2240
2342
|
},
|
|
2241
2343
|
"first_party_worker": {
|
|
2242
|
-
"description": "Designates this
|
|
2344
|
+
"description": "Designates this Worker as an internal-only \"first-party\" Worker.",
|
|
2243
2345
|
"type": "boolean"
|
|
2244
2346
|
},
|
|
2245
2347
|
"hyperdrive": {
|
|
@@ -2249,7 +2351,7 @@
|
|
|
2249
2351
|
"additionalProperties": false,
|
|
2250
2352
|
"properties": {
|
|
2251
2353
|
"binding": {
|
|
2252
|
-
"description": "The binding name used to refer to the project in the
|
|
2354
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
|
2253
2355
|
"type": "string"
|
|
2254
2356
|
},
|
|
2255
2357
|
"id": {
|
|
@@ -2348,23 +2450,77 @@
|
|
|
2348
2450
|
"type": "object"
|
|
2349
2451
|
},
|
|
2350
2452
|
"logpush": {
|
|
2351
|
-
"description": "Send Trace Events from this
|
|
2453
|
+
"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/",
|
|
2352
2454
|
"type": "boolean"
|
|
2353
2455
|
},
|
|
2354
2456
|
"main": {
|
|
2355
2457
|
"description": "The entrypoint/path to the JavaScript file that will be executed.",
|
|
2356
2458
|
"type": "string"
|
|
2357
2459
|
},
|
|
2460
|
+
"migrations": {
|
|
2461
|
+
"default": [],
|
|
2462
|
+
"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",
|
|
2463
|
+
"items": {
|
|
2464
|
+
"additionalProperties": false,
|
|
2465
|
+
"properties": {
|
|
2466
|
+
"deleted_classes": {
|
|
2467
|
+
"description": "The Durable Objects being removed.",
|
|
2468
|
+
"items": {
|
|
2469
|
+
"type": "string"
|
|
2470
|
+
},
|
|
2471
|
+
"type": "array"
|
|
2472
|
+
},
|
|
2473
|
+
"new_classes": {
|
|
2474
|
+
"description": "The new Durable Objects being defined.",
|
|
2475
|
+
"items": {
|
|
2476
|
+
"type": "string"
|
|
2477
|
+
},
|
|
2478
|
+
"type": "array"
|
|
2479
|
+
},
|
|
2480
|
+
"renamed_classes": {
|
|
2481
|
+
"description": "The Durable Objects being renamed.",
|
|
2482
|
+
"items": {
|
|
2483
|
+
"additionalProperties": false,
|
|
2484
|
+
"properties": {
|
|
2485
|
+
"from": {
|
|
2486
|
+
"type": "string"
|
|
2487
|
+
},
|
|
2488
|
+
"to": {
|
|
2489
|
+
"type": "string"
|
|
2490
|
+
}
|
|
2491
|
+
},
|
|
2492
|
+
"required": [
|
|
2493
|
+
"from",
|
|
2494
|
+
"to"
|
|
2495
|
+
],
|
|
2496
|
+
"type": "object"
|
|
2497
|
+
},
|
|
2498
|
+
"type": "array"
|
|
2499
|
+
},
|
|
2500
|
+
"tag": {
|
|
2501
|
+
"description": "A unique identifier for this migration.",
|
|
2502
|
+
"type": "string"
|
|
2503
|
+
}
|
|
2504
|
+
},
|
|
2505
|
+
"required": [
|
|
2506
|
+
"tag"
|
|
2507
|
+
],
|
|
2508
|
+
"type": "object"
|
|
2509
|
+
},
|
|
2510
|
+
"type": "array"
|
|
2511
|
+
},
|
|
2358
2512
|
"minify": {
|
|
2359
2513
|
"description": "Minify the script before uploading.",
|
|
2360
2514
|
"type": "boolean"
|
|
2361
2515
|
},
|
|
2362
2516
|
"mtls_certificates": {
|
|
2517
|
+
"default": "`[]`",
|
|
2518
|
+
"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.",
|
|
2363
2519
|
"items": {
|
|
2364
2520
|
"additionalProperties": false,
|
|
2365
2521
|
"properties": {
|
|
2366
2522
|
"binding": {
|
|
2367
|
-
"description": "The binding name used to refer to the certificate in the
|
|
2523
|
+
"description": "The binding name used to refer to the certificate in the Worker",
|
|
2368
2524
|
"type": "string"
|
|
2369
2525
|
},
|
|
2370
2526
|
"certificate_id": {
|
|
@@ -2381,7 +2537,7 @@
|
|
|
2381
2537
|
"type": "array"
|
|
2382
2538
|
},
|
|
2383
2539
|
"name": {
|
|
2384
|
-
"description": "The name of your
|
|
2540
|
+
"description": "The name of your Worker. Alphanumeric + dashes only.",
|
|
2385
2541
|
"type": "string"
|
|
2386
2542
|
},
|
|
2387
2543
|
"no_bundle": {
|
|
@@ -2394,7 +2550,7 @@
|
|
|
2394
2550
|
},
|
|
2395
2551
|
"placement": {
|
|
2396
2552
|
"additionalProperties": false,
|
|
2397
|
-
"description": "Specify how the
|
|
2553
|
+
"description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
|
|
2398
2554
|
"properties": {
|
|
2399
2555
|
"mode": {
|
|
2400
2556
|
"enum": [
|
|
@@ -2415,7 +2571,7 @@
|
|
|
2415
2571
|
},
|
|
2416
2572
|
"queues": {
|
|
2417
2573
|
"additionalProperties": false,
|
|
2418
|
-
"default": "`{}`",
|
|
2574
|
+
"default": "`{consumers:[],producers:[]}`",
|
|
2419
2575
|
"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.",
|
|
2420
2576
|
"properties": {
|
|
2421
2577
|
"consumers": {
|
|
@@ -2476,7 +2632,7 @@
|
|
|
2476
2632
|
"additionalProperties": false,
|
|
2477
2633
|
"properties": {
|
|
2478
2634
|
"binding": {
|
|
2479
|
-
"description": "The binding name used to refer to the Queue in the
|
|
2635
|
+
"description": "The binding name used to refer to the Queue in the Worker.",
|
|
2480
2636
|
"type": "string"
|
|
2481
2637
|
},
|
|
2482
2638
|
"delivery_delay": {
|
|
@@ -2506,7 +2662,7 @@
|
|
|
2506
2662
|
"additionalProperties": false,
|
|
2507
2663
|
"properties": {
|
|
2508
2664
|
"binding": {
|
|
2509
|
-
"description": "The binding name used to refer to the R2 bucket in the
|
|
2665
|
+
"description": "The binding name used to refer to the R2 bucket in the Worker.",
|
|
2510
2666
|
"type": "string"
|
|
2511
2667
|
},
|
|
2512
2668
|
"bucket_name": {
|
|
@@ -2532,10 +2688,10 @@
|
|
|
2532
2688
|
},
|
|
2533
2689
|
"route": {
|
|
2534
2690
|
"$ref": "#/definitions/Route",
|
|
2535
|
-
"description": "A route that your
|
|
2691
|
+
"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"
|
|
2536
2692
|
},
|
|
2537
2693
|
"routes": {
|
|
2538
|
-
"description": "A list of routes that your
|
|
2694
|
+
"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`)",
|
|
2539
2695
|
"items": {
|
|
2540
2696
|
"$ref": "#/definitions/Route"
|
|
2541
2697
|
},
|
|
@@ -2579,7 +2735,7 @@
|
|
|
2579
2735
|
},
|
|
2580
2736
|
"services": {
|
|
2581
2737
|
"default": "`[]`",
|
|
2582
|
-
"description": "Specifies service bindings (
|
|
2738
|
+
"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.",
|
|
2583
2739
|
"items": {
|
|
2584
2740
|
"additionalProperties": false,
|
|
2585
2741
|
"properties": {
|
|
@@ -2609,6 +2765,8 @@
|
|
|
2609
2765
|
"type": "array"
|
|
2610
2766
|
},
|
|
2611
2767
|
"tail_consumers": {
|
|
2768
|
+
"default": "`[]`",
|
|
2769
|
+
"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.",
|
|
2612
2770
|
"items": {
|
|
2613
2771
|
"$ref": "#/definitions/TailConsumer"
|
|
2614
2772
|
},
|
|
@@ -2617,7 +2775,7 @@
|
|
|
2617
2775
|
"triggers": {
|
|
2618
2776
|
"additionalProperties": false,
|
|
2619
2777
|
"default": "`{crons:[]}`",
|
|
2620
|
-
"description": "\"Cron\" definitions to trigger a
|
|
2778
|
+
"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",
|
|
2621
2779
|
"properties": {
|
|
2622
2780
|
"crons": {
|
|
2623
2781
|
"items": {
|
|
@@ -2637,6 +2795,7 @@
|
|
|
2637
2795
|
},
|
|
2638
2796
|
"unsafe": {
|
|
2639
2797
|
"additionalProperties": false,
|
|
2798
|
+
"default": "`{}`",
|
|
2640
2799
|
"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.",
|
|
2641
2800
|
"properties": {
|
|
2642
2801
|
"bindings": {
|
|
@@ -2727,7 +2886,7 @@
|
|
|
2727
2886
|
]
|
|
2728
2887
|
},
|
|
2729
2888
|
"default": "`{}`",
|
|
2730
|
-
"description": "A map of environment variables to set when deploying your
|
|
2889
|
+
"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.",
|
|
2731
2890
|
"type": "object"
|
|
2732
2891
|
},
|
|
2733
2892
|
"vectorize": {
|
|
@@ -2737,7 +2896,7 @@
|
|
|
2737
2896
|
"additionalProperties": false,
|
|
2738
2897
|
"properties": {
|
|
2739
2898
|
"binding": {
|
|
2740
|
-
"description": "The binding name used to refer to the Vectorize index in the
|
|
2899
|
+
"description": "The binding name used to refer to the Vectorize index in the Worker.",
|
|
2741
2900
|
"type": "string"
|
|
2742
2901
|
},
|
|
2743
2902
|
"index_name": {
|
|
@@ -2768,7 +2927,7 @@
|
|
|
2768
2927
|
},
|
|
2769
2928
|
"workers_dev": {
|
|
2770
2929
|
"default": "`true` (This is a breaking change from Wrangler v1)",
|
|
2771
|
-
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your
|
|
2930
|
+
"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",
|
|
2772
2931
|
"type": "boolean"
|
|
2773
2932
|
},
|
|
2774
2933
|
"zone_id": {
|
|
@@ -2824,7 +2983,7 @@
|
|
|
2824
2983
|
"additionalProperties": false,
|
|
2825
2984
|
"properties": {
|
|
2826
2985
|
"environment": {
|
|
2827
|
-
"description": "(Optional) The
|
|
2986
|
+
"description": "(Optional) The environment of the service.",
|
|
2828
2987
|
"type": "string"
|
|
2829
2988
|
},
|
|
2830
2989
|
"service": {
|
|
@@ -2849,7 +3008,7 @@
|
|
|
2849
3008
|
"additionalProperties": false,
|
|
2850
3009
|
"properties": {
|
|
2851
3010
|
"cpu_ms": {
|
|
2852
|
-
"description": "Maximum allowed CPU time for a
|
|
3011
|
+
"description": "Maximum allowed CPU time for a Worker's invocation in milliseconds",
|
|
2853
3012
|
"type": "number"
|
|
2854
3013
|
}
|
|
2855
3014
|
},
|