nitro-nightly 3.0.1-20260121-181105-22bd0c63 → 3.0.1-20260121-183513-28f908a5
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/dist/_build/common.mjs +5 -5
- package/dist/_libs/c12+giget+readdirp+chokidar.d.mts +31 -31
- package/dist/_libs/commondir+is-reference.mjs +1 -1
- package/dist/_libs/compatx.d.mts +2 -2
- package/dist/_libs/hasown+resolve+deepmerge.mjs +1 -1
- package/dist/_libs/magic-string.d.mts +99 -99
- package/dist/_libs/mlly.d.mts +25 -25
- package/dist/_libs/plugin-alias.mjs +1 -1
- package/dist/_libs/plugin-inject.mjs +1 -1
- package/dist/_libs/plugin-json.mjs +1 -1
- package/dist/_libs/pluginutils+plugin-commonjs.d.mts +192 -192
- package/dist/_libs/unplugin+unimport.d.mts +159 -159
- package/dist/_libs/unwasm.d.mts +14 -14
- package/dist/presets/_nitro/runtime/nitro-dev.mjs +1 -2
- package/dist/presets/bun/runtime/bun.mjs +3 -4
- package/dist/presets/cloudflare/runtime/cloudflare-durable.mjs +6 -7
- package/dist/presets/cloudflare/runtime/cloudflare-module.mjs +2 -3
- package/dist/presets/cloudflare/runtime/cloudflare-pages.mjs +2 -3
- package/dist/presets/deno/runtime/deno-deploy.mjs +2 -3
- package/dist/presets/deno/runtime/deno-server.mjs +1 -2
- package/dist/presets/node/runtime/node-cluster.mjs +1 -2
- package/dist/presets/node/runtime/node-middleware.mjs +1 -2
- package/dist/presets/node/runtime/node-server.mjs +1 -2
- package/dist/runtime/internal/vite/dev-entry.mjs +1 -2
- package/dist/runtime/virtual/feature-flags.d.mts +0 -1
- package/dist/runtime/virtual/feature-flags.mjs +0 -1
- package/dist/types/index.d.mts +828 -827
- package/dist/vite.d.mts +13 -13
- package/package.json +1 -1
package/dist/types/index.d.mts
CHANGED
|
@@ -133,8 +133,8 @@ interface CacheOptions<T = any, ArgsT extends unknown[] = any[]> {
|
|
|
133
133
|
group?: string;
|
|
134
134
|
integrity?: any;
|
|
135
135
|
/**
|
|
136
|
-
|
|
137
|
-
|
|
136
|
+
* Number of seconds to cache the response. Defaults to 1.
|
|
137
|
+
*/
|
|
138
138
|
maxAge?: number;
|
|
139
139
|
swr?: boolean;
|
|
140
140
|
staleMaxAge?: number;
|
|
@@ -230,22 +230,22 @@ interface TaskRunnerOptions {
|
|
|
230
230
|
type AmplifyImageSettings = {
|
|
231
231
|
/** Array of supported image widths */sizes: number[];
|
|
232
232
|
/**
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
233
|
+
* Array of allowed external domains that can use Image Optimization.
|
|
234
|
+
* Leave empty for only allowing the deployment domain to use Image Optimization.
|
|
235
|
+
*/
|
|
236
236
|
domains: string[];
|
|
237
237
|
/**
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
238
|
+
* Array of allowed external patterns that can use Image Optimization.
|
|
239
|
+
* Similar to `domains` but provides more control with RegExp.
|
|
240
|
+
*/
|
|
241
241
|
remotePatterns: {
|
|
242
242
|
/** The protocol of the allowed remote pattern. Can be `http` or `https`. */protocol?: "http" | "https";
|
|
243
243
|
/**
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
244
|
+
* The hostname of the allowed remote pattern.
|
|
245
|
+
* Can be literal or wildcard. Single `*` matches a single subdomain.
|
|
246
|
+
* Double `**` matches any number of subdomains.
|
|
247
|
+
* We will disallow blanket wildcards of `**` with nothing else.
|
|
248
|
+
*/
|
|
249
249
|
hostname: string; /** The port of the allowed remote pattern. */
|
|
250
250
|
port?: string; /** The pathname of the allowed remote pattern. */
|
|
251
251
|
pathname?: string;
|
|
@@ -331,56 +331,56 @@ type CloudchamberConfig = {
|
|
|
331
331
|
*/
|
|
332
332
|
type ContainerApp = {
|
|
333
333
|
/**
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
334
|
+
* Name of the application
|
|
335
|
+
* @optional Defaults to `worker_name-class_name` if not specified.
|
|
336
|
+
*/
|
|
337
337
|
name?: string;
|
|
338
338
|
/**
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
339
|
+
* Number of application instances
|
|
340
|
+
* @deprecated
|
|
341
|
+
* @hidden
|
|
342
|
+
*/
|
|
343
343
|
instances?: number;
|
|
344
344
|
/**
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
345
|
+
* Number of maximum application instances.
|
|
346
|
+
* @optional
|
|
347
|
+
*/
|
|
348
348
|
max_instances?: number;
|
|
349
349
|
/**
|
|
350
|
-
|
|
351
|
-
|
|
350
|
+
* The path to a Dockerfile, or an image URI for the Cloudflare registry.
|
|
351
|
+
*/
|
|
352
352
|
image: string;
|
|
353
353
|
/**
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
354
|
+
* Build context of the application.
|
|
355
|
+
* @optional - defaults to the directory of `image`.
|
|
356
|
+
*/
|
|
357
357
|
image_build_context?: string;
|
|
358
358
|
/**
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
359
|
+
* Image variables to be passed along the image at build time.
|
|
360
|
+
* @optional
|
|
361
|
+
*/
|
|
362
362
|
image_vars?: Record<string, string>;
|
|
363
363
|
/**
|
|
364
|
-
|
|
365
|
-
|
|
364
|
+
* The class name of the Durable Object the container is connected to.
|
|
365
|
+
*/
|
|
366
366
|
class_name: string;
|
|
367
367
|
/**
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
368
|
+
* The scheduling policy of the application
|
|
369
|
+
* @optional
|
|
370
|
+
* @default "default"
|
|
371
|
+
*/
|
|
372
372
|
scheduling_policy?: "regional" | "moon" | "default";
|
|
373
373
|
/**
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
374
|
+
* The instance type to be used for the container. This sets preconfigured options for vcpu and memory
|
|
375
|
+
* @optional
|
|
376
|
+
*/
|
|
377
377
|
instance_type?: "dev" | "basic" | "standard";
|
|
378
378
|
/**
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
379
|
+
* @deprecated Use top level `containers` fields instead.
|
|
380
|
+
* `configuration.image` should be `image`
|
|
381
|
+
* `configuration.disk` should be set via `instance_type`
|
|
382
|
+
* @hidden
|
|
383
|
+
*/
|
|
384
384
|
configuration?: {
|
|
385
385
|
image?: string;
|
|
386
386
|
labels?: {
|
|
@@ -397,35 +397,35 @@ type ContainerApp = {
|
|
|
397
397
|
};
|
|
398
398
|
};
|
|
399
399
|
/**
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
400
|
+
* Scheduling constraints
|
|
401
|
+
* @hidden
|
|
402
|
+
*/
|
|
403
403
|
constraints?: {
|
|
404
404
|
regions?: string[];
|
|
405
405
|
cities?: string[];
|
|
406
406
|
tier?: number;
|
|
407
407
|
};
|
|
408
408
|
/**
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
409
|
+
* @deprecated use the `class_name` field instead.
|
|
410
|
+
* @hidden
|
|
411
|
+
*/
|
|
412
412
|
durable_objects?: {
|
|
413
413
|
namespace_id: string;
|
|
414
414
|
};
|
|
415
415
|
/**
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
416
|
+
* How a rollout should be done, defining the size of it
|
|
417
|
+
* @optional
|
|
418
|
+
* @default 25
|
|
419
|
+
* */
|
|
420
420
|
rollout_step_percentage?: number;
|
|
421
421
|
/**
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
422
|
+
* How a rollout should be created. It supports the following modes:
|
|
423
|
+
* - full_auto: The container application will be rolled out fully automatically.
|
|
424
|
+
* - none: The container application won't have a roll out or update.
|
|
425
|
+
* - manual: The container application will be rollout fully by manually actioning progress steps.
|
|
426
|
+
* @optional
|
|
427
|
+
* @default "full_auto"
|
|
428
|
+
*/
|
|
429
429
|
rollout_kind?: "full_auto" | "none" | "full_manual";
|
|
430
430
|
};
|
|
431
431
|
/**
|
|
@@ -447,222 +447,222 @@ type DurableObjectMigration = {
|
|
|
447
447
|
*/
|
|
448
448
|
interface EnvironmentInheritable {
|
|
449
449
|
/**
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
450
|
+
* The name of your Worker. Alphanumeric + dashes only.
|
|
451
|
+
*
|
|
452
|
+
* @inheritable
|
|
453
|
+
*/
|
|
454
454
|
name: string | undefined;
|
|
455
455
|
/**
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
456
|
+
* This is the ID of the account associated with your zone.
|
|
457
|
+
* You might have more than one account, so make sure to use
|
|
458
|
+
* the ID of the account associated with the zone/route you
|
|
459
|
+
* provide, if you provide one. It can also be specified through
|
|
460
|
+
* the CLOUDFLARE_ACCOUNT_ID environment variable.
|
|
461
|
+
*
|
|
462
|
+
* @inheritable
|
|
463
|
+
*/
|
|
464
464
|
account_id: string | undefined;
|
|
465
465
|
/**
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
466
|
+
* A date in the form yyyy-mm-dd, which will be used to determine
|
|
467
|
+
* which version of the Workers runtime is used.
|
|
468
|
+
*
|
|
469
|
+
* More details at https://developers.cloudflare.com/workers/configuration/compatibility-dates
|
|
470
|
+
*
|
|
471
|
+
* @inheritable
|
|
472
|
+
*/
|
|
473
473
|
compatibility_date: string | undefined;
|
|
474
474
|
/**
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
475
|
+
* A list of flags that enable features from upcoming features of
|
|
476
|
+
* the Workers runtime, usually used together with compatibility_date.
|
|
477
|
+
*
|
|
478
|
+
* More details at https://developers.cloudflare.com/workers/configuration/compatibility-flags/
|
|
479
|
+
*
|
|
480
|
+
* @default []
|
|
481
|
+
* @inheritable
|
|
482
|
+
*/
|
|
483
483
|
compatibility_flags: string[];
|
|
484
484
|
/**
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
485
|
+
* The entrypoint/path to the JavaScript file that will be executed.
|
|
486
|
+
*
|
|
487
|
+
* @inheritable
|
|
488
|
+
*/
|
|
489
489
|
main: string | undefined;
|
|
490
490
|
/**
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
491
|
+
* If true then Wrangler will traverse the file tree below `base_dir`;
|
|
492
|
+
* Any files that match `rules` will be included in the deployed Worker.
|
|
493
|
+
* Defaults to true if `no_bundle` is true, otherwise false.
|
|
494
|
+
*
|
|
495
|
+
* @inheritable
|
|
496
|
+
*/
|
|
497
497
|
find_additional_modules: boolean | undefined;
|
|
498
498
|
/**
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
499
|
+
* Determines whether Wrangler will preserve bundled file names.
|
|
500
|
+
* Defaults to false.
|
|
501
|
+
* If left unset, files will be named using the pattern ${fileHash}-${basename},
|
|
502
|
+
* for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.
|
|
503
|
+
*
|
|
504
|
+
* @inheritable
|
|
505
|
+
*/
|
|
506
506
|
preserve_file_names: boolean | undefined;
|
|
507
507
|
/**
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
508
|
+
* The directory in which module rules should be evaluated when including additional files into a Worker deployment.
|
|
509
|
+
* This defaults to the directory containing the `main` entry point of the Worker if not specified.
|
|
510
|
+
*
|
|
511
|
+
* @inheritable
|
|
512
|
+
*/
|
|
513
513
|
base_dir: string | undefined;
|
|
514
514
|
/**
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
515
|
+
* Whether we use <name>.<subdomain>.workers.dev to
|
|
516
|
+
* test and deploy your Worker.
|
|
517
|
+
*
|
|
518
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#workersdev
|
|
519
|
+
*
|
|
520
|
+
* @default true
|
|
521
|
+
* @breaking
|
|
522
|
+
* @inheritable
|
|
523
|
+
*/
|
|
524
524
|
workers_dev: boolean | undefined;
|
|
525
525
|
/**
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
526
|
+
* Whether we use <version>-<name>.<subdomain>.workers.dev to
|
|
527
|
+
* serve Preview URLs for your Worker.
|
|
528
|
+
*
|
|
529
|
+
* @default true
|
|
530
|
+
* @inheritable
|
|
531
|
+
*/
|
|
532
532
|
preview_urls: boolean | undefined;
|
|
533
533
|
/**
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
534
|
+
* A list of routes that your Worker should be published to.
|
|
535
|
+
* Only one of `routes` or `route` is required.
|
|
536
|
+
*
|
|
537
|
+
* Only required when workers_dev is false, and there's no scheduled Worker (see `triggers`)
|
|
538
|
+
*
|
|
539
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#types-of-routes
|
|
540
|
+
*
|
|
541
|
+
* @inheritable
|
|
542
|
+
*/
|
|
543
543
|
routes: Route$1[] | undefined;
|
|
544
544
|
/**
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
545
|
+
* A route that your Worker should be published to. Literally
|
|
546
|
+
* the same as routes, but only one.
|
|
547
|
+
* Only one of `routes` or `route` is required.
|
|
548
|
+
*
|
|
549
|
+
* Only required when workers_dev is false, and there's no scheduled Worker
|
|
550
|
+
*
|
|
551
|
+
* @inheritable
|
|
552
|
+
*/
|
|
553
553
|
route: Route$1 | undefined;
|
|
554
554
|
/**
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
555
|
+
* Path to a custom tsconfig
|
|
556
|
+
*
|
|
557
|
+
* @inheritable
|
|
558
|
+
*/
|
|
559
559
|
tsconfig: string | undefined;
|
|
560
560
|
/**
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
561
|
+
* The function to use to replace jsx syntax.
|
|
562
|
+
*
|
|
563
|
+
* @default "React.createElement"
|
|
564
|
+
* @inheritable
|
|
565
|
+
*/
|
|
566
566
|
jsx_factory: string;
|
|
567
567
|
/**
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
568
|
+
* The function to use to replace jsx fragment syntax.
|
|
569
|
+
*
|
|
570
|
+
* @default "React.Fragment"
|
|
571
|
+
* @inheritable
|
|
572
|
+
*/
|
|
573
573
|
jsx_fragment: string;
|
|
574
574
|
/**
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
575
|
+
* A list of migrations that should be uploaded with your Worker.
|
|
576
|
+
*
|
|
577
|
+
* These define changes in your Durable Object declarations.
|
|
578
|
+
*
|
|
579
|
+
* More details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations
|
|
580
|
+
*
|
|
581
|
+
* @default []
|
|
582
|
+
* @inheritable
|
|
583
|
+
*/
|
|
584
584
|
migrations: DurableObjectMigration[];
|
|
585
585
|
/**
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
586
|
+
* "Cron" definitions to trigger a Worker's "scheduled" function.
|
|
587
|
+
*
|
|
588
|
+
* Lets you call Workers periodically, much like a cron job.
|
|
589
|
+
*
|
|
590
|
+
* More details here https://developers.cloudflare.com/workers/platform/cron-triggers
|
|
591
|
+
*
|
|
592
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#triggers
|
|
593
|
+
*
|
|
594
|
+
* @default {crons: undefined}
|
|
595
|
+
* @inheritable
|
|
596
|
+
*/
|
|
597
597
|
triggers: {
|
|
598
598
|
crons: string[] | undefined;
|
|
599
599
|
};
|
|
600
600
|
/**
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
601
|
+
* Specify limits for runtime behavior.
|
|
602
|
+
* Only supported for the "standard" Usage Model
|
|
603
|
+
*
|
|
604
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#limits
|
|
605
|
+
*
|
|
606
|
+
* @inheritable
|
|
607
|
+
*/
|
|
608
608
|
limits: UserLimits | undefined;
|
|
609
609
|
/**
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
610
|
+
* An ordered list of rules that define which modules to import,
|
|
611
|
+
* and what type to import them as. You will need to specify rules
|
|
612
|
+
* to use Text, Data, and CompiledWasm modules, or when you wish to
|
|
613
|
+
* have a .js file be treated as an ESModule instead of CommonJS.
|
|
614
|
+
*
|
|
615
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#bundling
|
|
616
|
+
*
|
|
617
|
+
* @inheritable
|
|
618
|
+
*/
|
|
619
619
|
rules: Rule[];
|
|
620
620
|
/**
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
621
|
+
* Configures a custom build step to be run by Wrangler when building your Worker.
|
|
622
|
+
*
|
|
623
|
+
* Refer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build)
|
|
624
|
+
* for more details.
|
|
625
|
+
*
|
|
626
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#custom-builds
|
|
627
|
+
*
|
|
628
|
+
* @default {watch_dir:"./src"}
|
|
629
|
+
*/
|
|
630
630
|
build: {
|
|
631
631
|
/** 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. */command?: string; /** The directory in which the command is executed. */
|
|
632
632
|
cwd?: string; /** The directory to watch for changes while using wrangler dev, defaults to the current working directory */
|
|
633
633
|
watch_dir?: string | string[];
|
|
634
634
|
};
|
|
635
635
|
/**
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
636
|
+
* Skip internal build steps and directly deploy script
|
|
637
|
+
* @inheritable
|
|
638
|
+
*/
|
|
639
639
|
no_bundle: boolean | undefined;
|
|
640
640
|
/**
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
641
|
+
* Minify the script before uploading.
|
|
642
|
+
* @inheritable
|
|
643
|
+
*/
|
|
644
644
|
minify: boolean | undefined;
|
|
645
645
|
/**
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
646
|
+
* Set the `name` property to the original name for functions and classes renamed during minification.
|
|
647
|
+
*
|
|
648
|
+
* See https://esbuild.github.io/api/#keep-names
|
|
649
|
+
*
|
|
650
|
+
* @default true
|
|
651
|
+
* @inheritable
|
|
652
|
+
*/
|
|
653
653
|
keep_names: boolean | undefined;
|
|
654
654
|
/**
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
655
|
+
* Designates this Worker as an internal-only "first-party" Worker.
|
|
656
|
+
*
|
|
657
|
+
* @inheritable
|
|
658
|
+
*/
|
|
659
659
|
first_party_worker: boolean | undefined;
|
|
660
660
|
/**
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
661
|
+
* List of bindings that you will send to logfwdr
|
|
662
|
+
*
|
|
663
|
+
* @default {bindings:[]}
|
|
664
|
+
* @inheritable
|
|
665
|
+
*/
|
|
666
666
|
logfwdr: {
|
|
667
667
|
bindings: {
|
|
668
668
|
/** The binding name used to refer to logfwdr */name: string; /** The destination for this logged message */
|
|
@@ -670,59 +670,59 @@ interface EnvironmentInheritable {
|
|
|
670
670
|
}[];
|
|
671
671
|
};
|
|
672
672
|
/**
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
673
|
+
* Send Trace Events from this Worker to Workers Logpush.
|
|
674
|
+
*
|
|
675
|
+
* This will not configure a corresponding Logpush job automatically.
|
|
676
|
+
*
|
|
677
|
+
* For more information about Workers Logpush, see:
|
|
678
|
+
* https://blog.cloudflare.com/logpush-for-workers/
|
|
679
|
+
*
|
|
680
|
+
* @inheritable
|
|
681
|
+
*/
|
|
682
682
|
logpush: boolean | undefined;
|
|
683
683
|
/**
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
684
|
+
* Include source maps when uploading this worker.
|
|
685
|
+
*
|
|
686
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#source-maps
|
|
687
|
+
*
|
|
688
|
+
* @inheritable
|
|
689
|
+
*/
|
|
690
690
|
upload_source_maps: boolean | undefined;
|
|
691
691
|
/**
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
692
|
+
* Specify how the Worker should be located to minimize round-trip time.
|
|
693
|
+
*
|
|
694
|
+
* More details: https://developers.cloudflare.com/workers/platform/smart-placement/
|
|
695
|
+
*
|
|
696
|
+
* @inheritable
|
|
697
|
+
*/
|
|
698
698
|
placement: {
|
|
699
699
|
mode: "off" | "smart";
|
|
700
700
|
hint?: string;
|
|
701
701
|
} | undefined;
|
|
702
702
|
/**
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
703
|
+
* Specify the directory of static assets to deploy/serve
|
|
704
|
+
*
|
|
705
|
+
* More details at https://developers.cloudflare.com/workers/frameworks/
|
|
706
|
+
*
|
|
707
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#assets
|
|
708
|
+
*
|
|
709
|
+
* @inheritable
|
|
710
|
+
*/
|
|
711
711
|
assets: Assets | undefined;
|
|
712
712
|
/**
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
713
|
+
* Specify the observability behavior of the Worker.
|
|
714
|
+
*
|
|
715
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#observability
|
|
716
|
+
*
|
|
717
|
+
* @inheritable
|
|
718
|
+
*/
|
|
719
719
|
observability: Observability | undefined;
|
|
720
720
|
/**
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
721
|
+
* Specify the compliance region mode of the Worker.
|
|
722
|
+
*
|
|
723
|
+
* Although if the user does not specify a compliance region, the default is `public`,
|
|
724
|
+
* it can be set to `undefined` in configuration to delegate to the CLOUDFLARE_COMPLIANCE_REGION environment variable.
|
|
725
|
+
*/
|
|
726
726
|
compliance_region: "public" | "fedramp_high" | undefined;
|
|
727
727
|
}
|
|
728
728
|
type DurableObjectBindings = {
|
|
@@ -747,89 +747,89 @@ type WorkflowBinding = {
|
|
|
747
747
|
*/
|
|
748
748
|
interface EnvironmentNonInheritable {
|
|
749
749
|
/**
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
750
|
+
* A map of values to substitute when deploying your Worker.
|
|
751
|
+
*
|
|
752
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
753
|
+
* and so must be specified in every named environment.
|
|
754
|
+
*
|
|
755
|
+
* @default {}
|
|
756
|
+
* @nonInheritable
|
|
757
|
+
*/
|
|
758
758
|
define: Record<string, string>;
|
|
759
759
|
/**
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
760
|
+
* A map of environment variables to set when deploying your Worker.
|
|
761
|
+
*
|
|
762
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
763
|
+
* and so must be specified in every named environment.
|
|
764
|
+
*
|
|
765
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
|
|
766
|
+
*
|
|
767
|
+
* @default {}
|
|
768
|
+
* @nonInheritable
|
|
769
|
+
*/
|
|
770
770
|
vars: Record<string, unknown>;
|
|
771
771
|
/**
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
772
|
+
* A list of durable objects that your Worker should be bound to.
|
|
773
|
+
*
|
|
774
|
+
* For more information about Durable Objects, see the documentation at
|
|
775
|
+
* https://developers.cloudflare.com/workers/learning/using-durable-objects
|
|
776
|
+
*
|
|
777
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
778
|
+
* and so must be specified in every named environment.
|
|
779
|
+
*
|
|
780
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
|
|
781
|
+
*
|
|
782
|
+
* @default {bindings:[]}
|
|
783
|
+
* @nonInheritable
|
|
784
|
+
*/
|
|
785
785
|
durable_objects: {
|
|
786
786
|
bindings: DurableObjectBindings;
|
|
787
787
|
};
|
|
788
788
|
/**
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
789
|
+
* A list of workflows that your Worker should be bound to.
|
|
790
|
+
*
|
|
791
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
792
|
+
* and so must be specified in every named environment.
|
|
793
|
+
*
|
|
794
|
+
* @default []
|
|
795
|
+
* @nonInheritable
|
|
796
|
+
*/
|
|
797
797
|
workflows: WorkflowBinding[];
|
|
798
798
|
/**
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
799
|
+
* Cloudchamber configuration
|
|
800
|
+
*
|
|
801
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
802
|
+
* and so must be specified in every named environment.
|
|
803
|
+
*
|
|
804
|
+
* @default {}
|
|
805
|
+
* @nonInheritable
|
|
806
|
+
*/
|
|
807
807
|
cloudchamber: CloudchamberConfig;
|
|
808
808
|
/**
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
809
|
+
* Container related configuration
|
|
810
|
+
*
|
|
811
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
812
|
+
* and so must be specified in every named environment.
|
|
813
|
+
*
|
|
814
|
+
* @default []
|
|
815
|
+
* @nonInheritable
|
|
816
|
+
*/
|
|
817
817
|
containers?: ContainerApp[];
|
|
818
818
|
/**
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
819
|
+
* These specify any Workers KV Namespaces you want to
|
|
820
|
+
* access from inside your Worker.
|
|
821
|
+
*
|
|
822
|
+
* To learn more about KV Namespaces,
|
|
823
|
+
* see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works
|
|
824
|
+
*
|
|
825
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
826
|
+
* and so must be specified in every named environment.
|
|
827
|
+
*
|
|
828
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
|
|
829
|
+
*
|
|
830
|
+
* @default []
|
|
831
|
+
* @nonInheritable
|
|
832
|
+
*/
|
|
833
833
|
kv_namespaces: {
|
|
834
834
|
/** The binding name used to refer to the KV Namespace */binding: string; /** The ID of the KV namespace */
|
|
835
835
|
id?: string; /** The ID of the KV namespace used during `wrangler dev` */
|
|
@@ -837,32 +837,32 @@ interface EnvironmentNonInheritable {
|
|
|
837
837
|
experimental_remote?: boolean;
|
|
838
838
|
}[];
|
|
839
839
|
/**
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
840
|
+
* These specify bindings to send email from inside your Worker.
|
|
841
|
+
*
|
|
842
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
843
|
+
* and so must be specified in every named environment.
|
|
844
|
+
*
|
|
845
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#email-bindings
|
|
846
|
+
*
|
|
847
|
+
* @default []
|
|
848
|
+
* @nonInheritable
|
|
849
|
+
*/
|
|
850
850
|
send_email: {
|
|
851
851
|
/** The binding name used to refer to the this binding */name: string; /** If this binding should be restricted to a specific verified address */
|
|
852
852
|
destination_address?: string; /** If this binding should be restricted to a set of verified addresses */
|
|
853
853
|
allowed_destination_addresses?: string[];
|
|
854
854
|
}[];
|
|
855
855
|
/**
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
856
|
+
* Specifies Queues that are bound to this Worker environment.
|
|
857
|
+
*
|
|
858
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
859
|
+
* and so must be specified in every named environment.
|
|
860
|
+
*
|
|
861
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#queues
|
|
862
|
+
*
|
|
863
|
+
* @default {consumers:[],producers:[]}
|
|
864
|
+
* @nonInheritable
|
|
865
|
+
*/
|
|
866
866
|
queues: {
|
|
867
867
|
/** Producer bindings */producers?: {
|
|
868
868
|
/** The binding name used to refer to the Queue in the Worker. */binding: string; /** The name of this Queue. */
|
|
@@ -883,16 +883,16 @@ interface EnvironmentNonInheritable {
|
|
|
883
883
|
}[];
|
|
884
884
|
};
|
|
885
885
|
/**
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
886
|
+
* Specifies R2 buckets that are bound to this Worker environment.
|
|
887
|
+
*
|
|
888
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
889
|
+
* and so must be specified in every named environment.
|
|
890
|
+
*
|
|
891
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
|
|
892
|
+
*
|
|
893
|
+
* @default []
|
|
894
|
+
* @nonInheritable
|
|
895
|
+
*/
|
|
896
896
|
r2_buckets: {
|
|
897
897
|
/** The binding name used to refer to the R2 bucket in the Worker. */binding: string; /** The name of this R2 bucket at the edge. */
|
|
898
898
|
bucket_name?: string; /** The preview name of this R2 bucket at the edge. */
|
|
@@ -901,16 +901,16 @@ interface EnvironmentNonInheritable {
|
|
|
901
901
|
experimental_remote?: boolean;
|
|
902
902
|
}[];
|
|
903
903
|
/**
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
904
|
+
* Specifies D1 databases that are bound to this Worker environment.
|
|
905
|
+
*
|
|
906
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
907
|
+
* and so must be specified in every named environment.
|
|
908
|
+
*
|
|
909
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
|
|
910
|
+
*
|
|
911
|
+
* @default []
|
|
912
|
+
* @nonInheritable
|
|
913
|
+
*/
|
|
914
914
|
d1_databases: {
|
|
915
915
|
/** The binding name used to refer to the D1 database in the Worker. */binding: string; /** The name of this D1 database. */
|
|
916
916
|
database_name?: string; /** The UUID of this D1 database (not required). */
|
|
@@ -922,48 +922,48 @@ interface EnvironmentNonInheritable {
|
|
|
922
922
|
experimental_remote?: boolean;
|
|
923
923
|
}[];
|
|
924
924
|
/**
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
925
|
+
* Specifies Vectorize indexes that are bound to this Worker environment.
|
|
926
|
+
*
|
|
927
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
928
|
+
* and so must be specified in every named environment.
|
|
929
|
+
*
|
|
930
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
|
|
931
|
+
*
|
|
932
|
+
* @default []
|
|
933
|
+
* @nonInheritable
|
|
934
|
+
*/
|
|
935
935
|
vectorize: {
|
|
936
936
|
/** The binding name used to refer to the Vectorize index in the Worker. */binding: string; /** The name of the index. */
|
|
937
937
|
index_name: string; /** Whether the Vectorize index should be remote or not (only available under `--x-remote-bindings`) */
|
|
938
938
|
experimental_remote?: boolean;
|
|
939
939
|
}[];
|
|
940
940
|
/**
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
941
|
+
* Specifies Hyperdrive configs that are bound to this Worker environment.
|
|
942
|
+
*
|
|
943
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
944
|
+
* and so must be specified in every named environment.
|
|
945
|
+
*
|
|
946
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
|
|
947
|
+
*
|
|
948
|
+
* @default []
|
|
949
|
+
* @nonInheritable
|
|
950
|
+
*/
|
|
951
951
|
hyperdrive: {
|
|
952
952
|
/** The binding name used to refer to the project in the Worker. */binding: string; /** The id of the database. */
|
|
953
953
|
id: string; /** The local database connection string for `wrangler dev` */
|
|
954
954
|
localConnectionString?: string;
|
|
955
955
|
}[];
|
|
956
956
|
/**
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
957
|
+
* Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.
|
|
958
|
+
*
|
|
959
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
960
|
+
* and so must be specified in every named environment.
|
|
961
|
+
*
|
|
962
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
|
|
963
|
+
*
|
|
964
|
+
* @default []
|
|
965
|
+
* @nonInheritable
|
|
966
|
+
*/
|
|
967
967
|
services: {
|
|
968
968
|
/** The binding name used to refer to the bound service. */binding: string; /** The name of the service. */
|
|
969
969
|
service: string; /** The environment of the service (e.g. production, staging, etc). */
|
|
@@ -973,102 +973,102 @@ interface EnvironmentNonInheritable {
|
|
|
973
973
|
experimental_remote?: boolean;
|
|
974
974
|
}[] | undefined;
|
|
975
975
|
/**
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
976
|
+
* Specifies analytics engine datasets that are bound to this Worker environment.
|
|
977
|
+
*
|
|
978
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
979
|
+
* and so must be specified in every named environment.
|
|
980
|
+
*
|
|
981
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
|
|
982
|
+
*
|
|
983
|
+
* @default []
|
|
984
|
+
* @nonInheritable
|
|
985
|
+
*/
|
|
986
986
|
analytics_engine_datasets: {
|
|
987
987
|
/** The binding name used to refer to the dataset in the Worker. */binding: string; /** The name of this dataset to write to. */
|
|
988
988
|
dataset?: string;
|
|
989
989
|
}[];
|
|
990
990
|
/**
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
991
|
+
* A browser that will be usable from the Worker.
|
|
992
|
+
*
|
|
993
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
994
|
+
* and so must be specified in every named environment.
|
|
995
|
+
*
|
|
996
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
|
|
997
|
+
*
|
|
998
|
+
* @default {}
|
|
999
|
+
* @nonInheritable
|
|
1000
|
+
*/
|
|
1001
1001
|
browser: {
|
|
1002
1002
|
binding: string; /** Whether the Browser binding should be remote or not (only available under `--x-remote-bindings`) */
|
|
1003
1003
|
experimental_remote?: boolean;
|
|
1004
1004
|
} | undefined;
|
|
1005
1005
|
/**
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1006
|
+
* Binding to the AI project.
|
|
1007
|
+
*
|
|
1008
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1009
|
+
* and so must be specified in every named environment.
|
|
1010
|
+
*
|
|
1011
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
|
|
1012
|
+
*
|
|
1013
|
+
* @default {}
|
|
1014
|
+
* @nonInheritable
|
|
1015
|
+
*/
|
|
1016
1016
|
ai: {
|
|
1017
1017
|
binding: string;
|
|
1018
1018
|
staging?: boolean; /** Whether the AI binding should be remote or not (only available under `--x-remote-bindings`) */
|
|
1019
1019
|
experimental_remote?: boolean;
|
|
1020
1020
|
} | undefined;
|
|
1021
1021
|
/**
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1022
|
+
* Binding to Cloudflare Images
|
|
1023
|
+
*
|
|
1024
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1025
|
+
* and so must be specified in every named environment.
|
|
1026
|
+
*
|
|
1027
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#images
|
|
1028
|
+
*
|
|
1029
|
+
* @default {}
|
|
1030
|
+
* @nonInheritable
|
|
1031
|
+
*/
|
|
1032
1032
|
images: {
|
|
1033
1033
|
binding: string; /** Whether the Images binding should be remote or not (only available under `--x-remote-bindings`) */
|
|
1034
1034
|
experimental_remote?: boolean;
|
|
1035
1035
|
} | undefined;
|
|
1036
1036
|
/**
|
|
1037
|
-
|
|
1038
|
-
|
|
1037
|
+
* Binding to the Worker Version's metadata
|
|
1038
|
+
*/
|
|
1039
1039
|
version_metadata: {
|
|
1040
1040
|
binding: string;
|
|
1041
1041
|
} | undefined;
|
|
1042
1042
|
/**
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1043
|
+
* "Unsafe" tables for features that aren't directly supported by wrangler.
|
|
1044
|
+
*
|
|
1045
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1046
|
+
* and so must be specified in every named environment.
|
|
1047
|
+
*
|
|
1048
|
+
* @default {}
|
|
1049
|
+
* @nonInheritable
|
|
1050
|
+
*/
|
|
1051
1051
|
unsafe: {
|
|
1052
1052
|
/**
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1053
|
+
* A set of bindings that should be put into a Worker's upload metadata without changes. These
|
|
1054
|
+
* can be used to implement bindings for features that haven't released and aren't supported
|
|
1055
|
+
* directly by wrangler or miniflare.
|
|
1056
|
+
*/
|
|
1057
1057
|
bindings?: {
|
|
1058
1058
|
name: string;
|
|
1059
1059
|
type: string;
|
|
1060
1060
|
[key: string]: unknown;
|
|
1061
1061
|
}[];
|
|
1062
1062
|
/**
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1063
|
+
* Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified
|
|
1064
|
+
* here will always be applied to metadata last, so can add new or override existing fields.
|
|
1065
|
+
*/
|
|
1066
1066
|
metadata?: {
|
|
1067
1067
|
[key: string]: unknown;
|
|
1068
1068
|
};
|
|
1069
1069
|
/**
|
|
1070
|
-
|
|
1071
|
-
|
|
1070
|
+
* Used for internal capnp uploads for the Workers runtime
|
|
1071
|
+
*/
|
|
1072
1072
|
capnp?: {
|
|
1073
1073
|
base_path: string;
|
|
1074
1074
|
source_schemas: string[];
|
|
@@ -1080,42 +1080,42 @@ interface EnvironmentNonInheritable {
|
|
|
1080
1080
|
};
|
|
1081
1081
|
};
|
|
1082
1082
|
/**
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1083
|
+
* Specifies a list of mTLS certificates that are bound to this Worker environment.
|
|
1084
|
+
*
|
|
1085
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1086
|
+
* and so must be specified in every named environment.
|
|
1087
|
+
*
|
|
1088
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
|
|
1089
|
+
*
|
|
1090
|
+
* @default []
|
|
1091
|
+
* @nonInheritable
|
|
1092
|
+
*/
|
|
1093
1093
|
mtls_certificates: {
|
|
1094
1094
|
/** The binding name used to refer to the certificate in the Worker */binding: string; /** The uuid of the uploaded mTLS certificate */
|
|
1095
1095
|
certificate_id: string; /** Whether the mtls fetcher should be remote or not (only available under `--x-remote-bindings`) */
|
|
1096
1096
|
experimental_remote?: boolean;
|
|
1097
1097
|
}[];
|
|
1098
1098
|
/**
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1099
|
+
* Specifies a list of Tail Workers that are bound to this Worker environment
|
|
1100
|
+
*
|
|
1101
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1102
|
+
* and so must be specified in every named environment.
|
|
1103
|
+
*
|
|
1104
|
+
* @default []
|
|
1105
|
+
* @nonInheritable
|
|
1106
|
+
*/
|
|
1107
1107
|
tail_consumers?: TailConsumer[];
|
|
1108
1108
|
/**
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1109
|
+
* Specifies namespace bindings that are bound to this Worker environment.
|
|
1110
|
+
*
|
|
1111
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1112
|
+
* and so must be specified in every named environment.
|
|
1113
|
+
*
|
|
1114
|
+
* For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
|
|
1115
|
+
*
|
|
1116
|
+
* @default []
|
|
1117
|
+
* @nonInheritable
|
|
1118
|
+
*/
|
|
1119
1119
|
dispatch_namespaces: {
|
|
1120
1120
|
/** The binding name used to refer to the bound service. */binding: string; /** The namespace to bind to. */
|
|
1121
1121
|
namespace: string; /** Details about the outbound Worker which will handle outbound requests from your namespace */
|
|
@@ -1123,41 +1123,41 @@ interface EnvironmentNonInheritable {
|
|
|
1123
1123
|
experimental_remote?: boolean;
|
|
1124
1124
|
}[];
|
|
1125
1125
|
/**
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1126
|
+
* Specifies list of Pipelines bound to this Worker environment
|
|
1127
|
+
*
|
|
1128
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1129
|
+
* and so must be specified in every named environment.
|
|
1130
|
+
*
|
|
1131
|
+
* @default []
|
|
1132
|
+
* @nonInheritable
|
|
1133
|
+
*/
|
|
1134
1134
|
pipelines: {
|
|
1135
1135
|
/** The binding name used to refer to the bound service. */binding: string; /** Name of the Pipeline to bind */
|
|
1136
1136
|
pipeline: string;
|
|
1137
1137
|
}[];
|
|
1138
1138
|
/**
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1139
|
+
* Specifies Secret Store bindings that are bound to this Worker environment.
|
|
1140
|
+
*
|
|
1141
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1142
|
+
* and so must be specified in every named environment.
|
|
1143
|
+
*
|
|
1144
|
+
* @default []
|
|
1145
|
+
* @nonInheritable
|
|
1146
|
+
*/
|
|
1147
1147
|
secrets_store_secrets: {
|
|
1148
1148
|
/** The binding name used to refer to the bound service. */binding: string; /** Id of the secret store */
|
|
1149
1149
|
store_id: string; /** Name of the secret */
|
|
1150
1150
|
secret_name: string;
|
|
1151
1151
|
}[];
|
|
1152
1152
|
/**
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1153
|
+
* **DO NOT USE**. Hello World Binding Config to serve as an explanatory example.
|
|
1154
|
+
*
|
|
1155
|
+
* NOTE: This field is not automatically inherited from the top level environment,
|
|
1156
|
+
* and so must be specified in every named environment.
|
|
1157
|
+
*
|
|
1158
|
+
* @default []
|
|
1159
|
+
* @nonInheritable
|
|
1160
|
+
*/
|
|
1161
1161
|
unsafe_hello_world: {
|
|
1162
1162
|
/** The binding name used to refer to the bound service. */binding: string; /** Whether the timer is enabled */
|
|
1163
1163
|
enable_timer?: boolean;
|
|
@@ -1197,10 +1197,10 @@ type Assets = {
|
|
|
1197
1197
|
html_handling?: "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash" | "none"; /** How to handle requests that do not match an asset. */
|
|
1198
1198
|
not_found_handling?: "single-page-application" | "404-page" | "none";
|
|
1199
1199
|
/**
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1200
|
+
* Matches will be routed to the User Worker, and matches to negative rules will go to the Asset Worker.
|
|
1201
|
+
*
|
|
1202
|
+
* Can also be `true`, indicating that every request should be routed to the User Worker.
|
|
1203
|
+
*/
|
|
1204
1204
|
run_worker_first?: string[] | boolean;
|
|
1205
1205
|
};
|
|
1206
1206
|
interface Observability {
|
|
@@ -1244,81 +1244,81 @@ interface ComputedFields {
|
|
|
1244
1244
|
/** The path to the user's Wrangler configuration file (if any), which may have been redirected to another file that used to create this configuration. */
|
|
1245
1245
|
userConfigPath: string | undefined;
|
|
1246
1246
|
/**
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1247
|
+
* The original top level name for the Worker in the raw configuration.
|
|
1248
|
+
*
|
|
1249
|
+
* When a raw configuration has been flattened to a single environment the worker name may have been replaced or transformed.
|
|
1250
|
+
* It can be useful to know what the top-level name was before the flattening.
|
|
1251
|
+
*/
|
|
1252
1252
|
topLevelName: string | undefined;
|
|
1253
1253
|
}
|
|
1254
1254
|
interface ConfigFields<Dev extends RawDevConfig> {
|
|
1255
1255
|
/**
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1256
|
+
* A boolean to enable "legacy" style wrangler environments (from Wrangler v1).
|
|
1257
|
+
* These have been superseded by Services, but there may be projects that won't
|
|
1258
|
+
* (or can't) use them. If you're using a legacy environment, you can set this
|
|
1259
|
+
* to `true` to enable it.
|
|
1260
|
+
*/
|
|
1261
1261
|
legacy_env: boolean;
|
|
1262
1262
|
/**
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1263
|
+
* Whether Wrangler should send usage metrics to Cloudflare for this project.
|
|
1264
|
+
*
|
|
1265
|
+
* When defined this will override any user settings.
|
|
1266
|
+
* Otherwise, Wrangler will use the user's preference.
|
|
1267
|
+
*/
|
|
1268
1268
|
send_metrics: boolean | undefined;
|
|
1269
1269
|
/**
|
|
1270
|
-
|
|
1271
|
-
|
|
1270
|
+
* Options to configure the development server that your worker will use.
|
|
1271
|
+
*/
|
|
1272
1272
|
dev: Dev;
|
|
1273
1273
|
/**
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1274
|
+
* The definition of a Worker Site, a feature that lets you upload
|
|
1275
|
+
* static assets with your Worker.
|
|
1276
|
+
*
|
|
1277
|
+
* More details at https://developers.cloudflare.com/workers/platform/sites
|
|
1278
|
+
*/
|
|
1279
1279
|
site: {
|
|
1280
1280
|
/**
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1281
|
+
* The directory containing your static assets.
|
|
1282
|
+
*
|
|
1283
|
+
* It must be a path relative to your Wrangler configuration file.
|
|
1284
|
+
* Example: bucket = "./public"
|
|
1285
|
+
*
|
|
1286
|
+
* If there is a `site` field then it must contain this `bucket` field.
|
|
1287
|
+
*/
|
|
1288
1288
|
bucket: string;
|
|
1289
1289
|
/**
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1290
|
+
* The location of your Worker script.
|
|
1291
|
+
*
|
|
1292
|
+
* @deprecated DO NOT use this (it's a holdover from Wrangler v1.x). Either use the top level `main` field, or pass the path to your entry file as a command line argument.
|
|
1293
|
+
* @breaking
|
|
1294
|
+
*/
|
|
1295
1295
|
"entry-point"?: string;
|
|
1296
1296
|
/**
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1297
|
+
* An exclusive list of .gitignore-style patterns that match file
|
|
1298
|
+
* or directory names from your bucket location. Only matched
|
|
1299
|
+
* items will be uploaded. Example: include = ["upload_dir"]
|
|
1300
|
+
*
|
|
1301
|
+
* @optional
|
|
1302
|
+
* @default []
|
|
1303
|
+
*/
|
|
1304
1304
|
include?: string[];
|
|
1305
1305
|
/**
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1306
|
+
* A list of .gitignore-style patterns that match files or
|
|
1307
|
+
* directories in your bucket that should be excluded from
|
|
1308
|
+
* uploads. Example: exclude = ["ignore_dir"]
|
|
1309
|
+
*
|
|
1310
|
+
* @optional
|
|
1311
|
+
* @default []
|
|
1312
|
+
*/
|
|
1313
1313
|
exclude?: string[];
|
|
1314
1314
|
} | undefined;
|
|
1315
1315
|
/**
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1316
|
+
* Old behaviour of serving a folder of static assets with your Worker,
|
|
1317
|
+
* without any additional code.
|
|
1318
|
+
* This can either be a string, or an object with additional config
|
|
1319
|
+
* fields.
|
|
1320
|
+
* Will be deprecated in the near future in favor of `assets`.
|
|
1321
|
+
*/
|
|
1322
1322
|
legacy_assets: {
|
|
1323
1323
|
bucket: string;
|
|
1324
1324
|
include: string[];
|
|
@@ -1327,95 +1327,95 @@ interface ConfigFields<Dev extends RawDevConfig> {
|
|
|
1327
1327
|
serve_single_page_app: boolean;
|
|
1328
1328
|
} | string | undefined;
|
|
1329
1329
|
/**
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1330
|
+
* A list of wasm modules that your worker should be bound to. This is
|
|
1331
|
+
* the "legacy" way of binding to a wasm module. ES module workers should
|
|
1332
|
+
* do proper module imports.
|
|
1333
|
+
*/
|
|
1334
1334
|
wasm_modules: {
|
|
1335
1335
|
[key: string]: string;
|
|
1336
1336
|
} | undefined;
|
|
1337
1337
|
/**
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1338
|
+
* A list of text files that your worker should be bound to. This is
|
|
1339
|
+
* the "legacy" way of binding to a text file. ES module workers should
|
|
1340
|
+
* do proper module imports.
|
|
1341
|
+
*/
|
|
1342
1342
|
text_blobs: {
|
|
1343
1343
|
[key: string]: string;
|
|
1344
1344
|
} | undefined;
|
|
1345
1345
|
/**
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1346
|
+
* A list of data files that your worker should be bound to. This is
|
|
1347
|
+
* the "legacy" way of binding to a data file. ES module workers should
|
|
1348
|
+
* do proper module imports.
|
|
1349
|
+
*/
|
|
1350
1350
|
data_blobs: {
|
|
1351
1351
|
[key: string]: string;
|
|
1352
1352
|
} | undefined;
|
|
1353
1353
|
/**
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1354
|
+
* A map of module aliases. Lets you swap out a module for any others.
|
|
1355
|
+
* Corresponds with esbuild's `alias` config
|
|
1356
|
+
*/
|
|
1357
1357
|
alias: {
|
|
1358
1358
|
[key: string]: string;
|
|
1359
1359
|
} | undefined;
|
|
1360
1360
|
/**
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1361
|
+
* By default, the Wrangler configuration file is the source of truth for your environment configuration, like a terraform file.
|
|
1362
|
+
*
|
|
1363
|
+
* If you change your vars in the dashboard, wrangler *will* override/delete them on its next deploy.
|
|
1364
|
+
*
|
|
1365
|
+
* If you want to keep your dashboard vars when wrangler deploys, set this field to true.
|
|
1366
|
+
*
|
|
1367
|
+
* @default false
|
|
1368
|
+
* @nonInheritable
|
|
1369
|
+
*/
|
|
1370
1370
|
keep_vars?: boolean;
|
|
1371
1371
|
}
|
|
1372
1372
|
interface PagesConfigFields {
|
|
1373
1373
|
/**
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1374
|
+
* The directory of static assets to serve.
|
|
1375
|
+
*
|
|
1376
|
+
* The presence of this field in a Wrangler configuration file indicates a Pages project,
|
|
1377
|
+
* and will prompt the handling of the configuration file according to the
|
|
1378
|
+
* Pages-specific validation rules.
|
|
1379
|
+
*/
|
|
1380
1380
|
pages_build_output_dir?: string;
|
|
1381
1381
|
}
|
|
1382
1382
|
interface DevConfig {
|
|
1383
1383
|
/**
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1384
|
+
* IP address for the local dev server to listen on,
|
|
1385
|
+
*
|
|
1386
|
+
* @default localhost
|
|
1387
|
+
*/
|
|
1388
1388
|
ip: string;
|
|
1389
1389
|
/**
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1390
|
+
* Port for the local dev server to listen on
|
|
1391
|
+
*
|
|
1392
|
+
* @default 8787
|
|
1393
|
+
*/
|
|
1394
1394
|
port: number | undefined;
|
|
1395
1395
|
/**
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1396
|
+
* Port for the local dev server's inspector to listen on
|
|
1397
|
+
*
|
|
1398
|
+
* @default 9229
|
|
1399
|
+
*/
|
|
1400
1400
|
inspector_port: number | undefined;
|
|
1401
1401
|
/**
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1402
|
+
* Protocol that local wrangler dev server listens to requests on.
|
|
1403
|
+
*
|
|
1404
|
+
* @default http
|
|
1405
|
+
*/
|
|
1406
1406
|
local_protocol: "http" | "https";
|
|
1407
1407
|
/**
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1408
|
+
* Protocol that wrangler dev forwards requests on
|
|
1409
|
+
*
|
|
1410
|
+
* Setting this to `http` is not currently implemented for remote mode.
|
|
1411
|
+
* See https://github.com/cloudflare/workers-sdk/issues/583
|
|
1412
|
+
*
|
|
1413
|
+
* @default https
|
|
1414
|
+
*/
|
|
1415
1415
|
upstream_protocol: "https" | "http";
|
|
1416
1416
|
/**
|
|
1417
|
-
|
|
1418
|
-
|
|
1417
|
+
* Host to forward requests to, defaults to the host of the first route of project
|
|
1418
|
+
*/
|
|
1419
1419
|
host: string | undefined;
|
|
1420
1420
|
}
|
|
1421
1421
|
type RawDevConfig = Partial<DevConfig>;
|
|
@@ -1435,30 +1435,30 @@ interface CloudflarePagesRoutes {
|
|
|
1435
1435
|
}
|
|
1436
1436
|
interface CloudflareOptions {
|
|
1437
1437
|
/**
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1438
|
+
* Configuration for the Cloudflare Deployments.
|
|
1439
|
+
*
|
|
1440
|
+
* **NOTE:** This option is only effective if `deployConfig` is enabled.
|
|
1441
|
+
*/
|
|
1442
1442
|
wrangler?: WranglerConfig;
|
|
1443
1443
|
/**
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1444
|
+
* Enable automatic generation of `.wrangler/deploy/config.json`.
|
|
1445
|
+
*
|
|
1446
|
+
* **IMPORTANT:** Enabling this option will cause settings from cloudflare dashboard (including environment variables) to be disabled and discarded.
|
|
1447
|
+
*
|
|
1448
|
+
* More info: https://developers.cloudflare.com/workers/wrangler/configuration#generated-wrangler-configuration
|
|
1449
|
+
*/
|
|
1450
1450
|
deployConfig?: boolean;
|
|
1451
1451
|
/**
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1452
|
+
* Enable native Node.js compatibility support.
|
|
1453
|
+
*
|
|
1454
|
+
* If this option disabled, pure unenv polyfills will be used instead.
|
|
1455
|
+
*
|
|
1456
|
+
* If not set, will be auto enabled if `nodejs_compat` or `nodejs_compat_v2` is detected in `wrangler.toml` or `wrangler.json`.
|
|
1457
|
+
*/
|
|
1458
1458
|
nodeCompat?: boolean;
|
|
1459
1459
|
/**
|
|
1460
|
-
|
|
1461
|
-
|
|
1460
|
+
* Options for dev emulation.
|
|
1461
|
+
*/
|
|
1462
1462
|
dev?: {
|
|
1463
1463
|
configPath?: string;
|
|
1464
1464
|
environment?: string;
|
|
@@ -1466,36 +1466,36 @@ interface CloudflareOptions {
|
|
|
1466
1466
|
};
|
|
1467
1467
|
pages?: {
|
|
1468
1468
|
/**
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1469
|
+
* Nitro will automatically generate a `_routes.json` that controls which files get served statically and
|
|
1470
|
+
* which get served by the Worker. Using this config will override the automatic `_routes.json`. Or, if the
|
|
1471
|
+
* `merge` options is set, it will merge the user-set routes with the auto-generated ones, giving priority
|
|
1472
|
+
* to the user routes.
|
|
1473
|
+
*
|
|
1474
|
+
* @see https://developers.cloudflare.com/pages/platform/functions/routing/#functions-invocation-routes
|
|
1475
|
+
*
|
|
1476
|
+
* There are a maximum of 100 rules, and you must have at least one include rule. Wildcards are accepted.
|
|
1477
|
+
*
|
|
1478
|
+
* If any fields are unset, they default to:
|
|
1479
|
+
*
|
|
1480
|
+
* ```json
|
|
1481
|
+
* {
|
|
1482
|
+
* "version": 1,
|
|
1483
|
+
* "include": ["/*"],
|
|
1484
|
+
* "exclude": []
|
|
1485
|
+
* }
|
|
1486
|
+
* ```
|
|
1487
|
+
*/
|
|
1488
1488
|
routes?: CloudflarePagesRoutes;
|
|
1489
1489
|
/**
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1490
|
+
* If set to `false`, nitro will disable the automatically generated `_routes.json` and instead use the user-set only ones.
|
|
1491
|
+
*
|
|
1492
|
+
* @default true
|
|
1493
|
+
*/
|
|
1494
1494
|
defaultRoutes?: boolean;
|
|
1495
1495
|
};
|
|
1496
1496
|
/**
|
|
1497
|
-
|
|
1498
|
-
|
|
1497
|
+
* Custom Cloudflare exports additional classes such as WorkflowEntrypoint.
|
|
1498
|
+
*/
|
|
1499
1499
|
exports?: string;
|
|
1500
1500
|
}
|
|
1501
1501
|
type DurableObjectState = ConstructorParameters<typeof DurableObject>[0];
|
|
@@ -1672,68 +1672,68 @@ interface VercelBuildConfigV3 {
|
|
|
1672
1672
|
*/
|
|
1673
1673
|
interface VercelServerlessFunctionConfig {
|
|
1674
1674
|
/**
|
|
1675
|
-
|
|
1676
|
-
|
|
1675
|
+
* Amount of memory (RAM in MB) that will be allocated to the Serverless Function.
|
|
1676
|
+
*/
|
|
1677
1677
|
memory?: number;
|
|
1678
1678
|
/**
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1679
|
+
* Specifies the instruction set "architecture" the Vercel Function supports.
|
|
1680
|
+
*
|
|
1681
|
+
* Either `x86_64` or `arm64`. The default value is `x86_64`
|
|
1682
|
+
*/
|
|
1683
1683
|
architecture?: "x86_64" | "arm64";
|
|
1684
1684
|
/**
|
|
1685
|
-
|
|
1686
|
-
|
|
1685
|
+
* Maximum execution duration (in seconds) that will be allowed for the Serverless Function.
|
|
1686
|
+
*/
|
|
1687
1687
|
maxDuration?: number;
|
|
1688
1688
|
/**
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1689
|
+
* Map of additional environment variables that will be available to the Vercel Function,
|
|
1690
|
+
* in addition to the env vars specified in the Project Settings.
|
|
1691
|
+
*/
|
|
1692
1692
|
environment?: Record<string, string>;
|
|
1693
1693
|
/**
|
|
1694
|
-
|
|
1695
|
-
|
|
1694
|
+
* List of Vercel Regions where the Vercel Function will be deployed to.
|
|
1695
|
+
*/
|
|
1696
1696
|
regions?: string[];
|
|
1697
1697
|
/**
|
|
1698
|
-
|
|
1699
|
-
|
|
1698
|
+
* True if a custom runtime has support for Lambda runtime wrappers.
|
|
1699
|
+
*/
|
|
1700
1700
|
supportsWrapper?: boolean;
|
|
1701
1701
|
/**
|
|
1702
|
-
|
|
1703
|
-
|
|
1702
|
+
* When true, the Serverless Function will stream the response to the client.
|
|
1703
|
+
*/
|
|
1704
1704
|
supportsResponseStreaming?: boolean;
|
|
1705
1705
|
/**
|
|
1706
|
-
|
|
1707
|
-
|
|
1706
|
+
* Enables source map generation.
|
|
1707
|
+
*/
|
|
1708
1708
|
shouldAddSourcemapSupport?: boolean;
|
|
1709
1709
|
/**
|
|
1710
|
-
|
|
1711
|
-
|
|
1710
|
+
* The runtime to use. Defaults to the auto-detected Node.js version.
|
|
1711
|
+
*/
|
|
1712
1712
|
runtime?: "nodejs20.x" | "nodejs22.x" | "bun1.x" | (string & {});
|
|
1713
1713
|
[key: string]: unknown;
|
|
1714
1714
|
}
|
|
1715
1715
|
interface VercelOptions {
|
|
1716
1716
|
config?: VercelBuildConfigV3;
|
|
1717
1717
|
/**
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1718
|
+
* If you have enabled skew protection in the Vercel dashboard, it will
|
|
1719
|
+
* be enabled by default.
|
|
1720
|
+
*
|
|
1721
|
+
* You can disable the Nitro integration by setting this option to `false`.
|
|
1722
|
+
*/
|
|
1723
1723
|
skewProtection?: boolean;
|
|
1724
1724
|
/**
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1725
|
+
* If you are using `vercel-edge`, you can specify the region(s) for your edge function.
|
|
1726
|
+
* @see https://vercel.com/docs/concepts/functions/edge-functions#edge-function-regions
|
|
1727
|
+
*/
|
|
1728
1728
|
regions?: string[];
|
|
1729
1729
|
functions?: VercelServerlessFunctionConfig;
|
|
1730
1730
|
/**
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1731
|
+
* Handler format to use for Vercel Serverless Functions.
|
|
1732
|
+
*
|
|
1733
|
+
* Using `node` format enables compatibility with Node.js specific APIs in your Nitro application (e.g., `req.runtime.node`).
|
|
1734
|
+
*
|
|
1735
|
+
* Possible values are: `web` (default) and `node`.
|
|
1736
|
+
*/
|
|
1737
1737
|
entryFormat?: "web" | "node";
|
|
1738
1738
|
}
|
|
1739
1739
|
//#endregion
|
|
@@ -1986,12 +1986,12 @@ interface ExternalDocumentationObject extends Extensable {
|
|
|
1986
1986
|
*/
|
|
1987
1987
|
interface ParameterObject extends Extensable {
|
|
1988
1988
|
/**
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
1989
|
+
* REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
1990
|
+
*
|
|
1991
|
+
* - If `in` is `"path"`, the `name` field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
|
|
1992
|
+
* - If `in` is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.
|
|
1993
|
+
* - For all other cases, the `name` corresponds to the parameter name used by the `in` property.
|
|
1994
|
+
*/
|
|
1995
1995
|
name: string;
|
|
1996
1996
|
/** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".*/
|
|
1997
1997
|
in: "query" | "header" | "path" | "cookie";
|
|
@@ -2341,46 +2341,46 @@ interface NitroRouteMeta {
|
|
|
2341
2341
|
}
|
|
2342
2342
|
interface NitroHandlerCommon {
|
|
2343
2343
|
/**
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2344
|
+
* HTTP pathname pattern to match
|
|
2345
|
+
*
|
|
2346
|
+
* Examples: `/test`, `/api/:id`, `/blog/**`
|
|
2347
|
+
*/
|
|
2348
2348
|
route: string;
|
|
2349
2349
|
/**
|
|
2350
|
-
|
|
2351
|
-
|
|
2350
|
+
* HTTP method to match
|
|
2351
|
+
*/
|
|
2352
2352
|
method?: HTTPMethod;
|
|
2353
2353
|
/**
|
|
2354
|
-
|
|
2355
|
-
|
|
2354
|
+
* Run handler as a middleware before other route handlings
|
|
2355
|
+
*/
|
|
2356
2356
|
middleware?: boolean;
|
|
2357
2357
|
/**
|
|
2358
|
-
|
|
2359
|
-
|
|
2358
|
+
* Extra Meta
|
|
2359
|
+
*/
|
|
2360
2360
|
meta?: NitroRouteMeta;
|
|
2361
2361
|
}
|
|
2362
2362
|
type EventHandlerFormat = "web" | "node";
|
|
2363
2363
|
interface NitroEventHandler extends NitroHandlerCommon {
|
|
2364
2364
|
/**
|
|
2365
|
-
|
|
2366
|
-
|
|
2365
|
+
* Use lazy loading to import handler
|
|
2366
|
+
*/
|
|
2367
2367
|
lazy?: boolean;
|
|
2368
2368
|
/**
|
|
2369
|
-
|
|
2370
|
-
|
|
2369
|
+
* Path to event handler
|
|
2370
|
+
*/
|
|
2371
2371
|
handler: string;
|
|
2372
2372
|
/**
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
|
|
2373
|
+
* Event handler type.
|
|
2374
|
+
*
|
|
2375
|
+
* Default is `"web"`. If set to `"node"`, the handler will be converted into a web compatible handler.
|
|
2376
|
+
*/
|
|
2377
2377
|
format?: EventHandlerFormat;
|
|
2378
2378
|
env?: MaybeArray$1<"dev" | "prod" | "prerender" | PresetName | (string & {})>;
|
|
2379
2379
|
}
|
|
2380
2380
|
interface NitroDevEventHandler extends NitroHandlerCommon {
|
|
2381
2381
|
/**
|
|
2382
|
-
|
|
2383
|
-
|
|
2382
|
+
* Event handler function
|
|
2383
|
+
*/
|
|
2384
2384
|
handler: HTTPHandler;
|
|
2385
2385
|
}
|
|
2386
2386
|
type MaybePromise<T> = T | Promise<T>;
|
|
@@ -2484,29 +2484,29 @@ type MatchedRouteRule<K extends keyof NitroRouteRules = "custom"> = {
|
|
|
2484
2484
|
type MatchedRouteRules = { [K in keyof NitroRouteRules]: MatchedRouteRule<K> };
|
|
2485
2485
|
interface VercelISRConfig {
|
|
2486
2486
|
/**
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
|
|
2487
|
+
* (vercel)
|
|
2488
|
+
* Expiration time (in seconds) before the cached asset will be re-generated by invoking the Serverless Function.
|
|
2489
|
+
* Setting the value to `false` (or `isr: true` route rule) means it will never expire.
|
|
2490
|
+
*/
|
|
2491
2491
|
expiration?: number | false;
|
|
2492
2492
|
/**
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
|
|
2493
|
+
* (vercel)
|
|
2494
|
+
* Group number of the asset.
|
|
2495
|
+
* Prerender assets with the same group number will all be re-validated at the same time.
|
|
2496
|
+
*/
|
|
2497
2497
|
group?: number;
|
|
2498
2498
|
/**
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2499
|
+
* (vercel)
|
|
2500
|
+
* List of query string parameter names that will be cached independently.
|
|
2501
|
+
* - If an empty array, query values are not considered for caching.
|
|
2502
|
+
* - If undefined each unique query value is cached independently
|
|
2503
|
+
* - For wildcard `/**` route rules, `url` is always added.
|
|
2504
|
+
*/
|
|
2505
2505
|
allowQuery?: string[];
|
|
2506
2506
|
/**
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2507
|
+
* (vercel)
|
|
2508
|
+
* When `true`, the query string will be present on the `request` argument passed to the invoked function. The `allowQuery` filter still applies.
|
|
2509
|
+
*/
|
|
2510
2510
|
passQuery?: boolean;
|
|
2511
2511
|
}
|
|
2512
2512
|
//#endregion
|
|
@@ -2633,47 +2633,47 @@ interface NitroModule {
|
|
|
2633
2633
|
*/
|
|
2634
2634
|
interface NitroOpenAPIConfig {
|
|
2635
2635
|
/**
|
|
2636
|
-
|
|
2637
|
-
|
|
2636
|
+
* OpenAPI meta information
|
|
2637
|
+
*/
|
|
2638
2638
|
meta?: {
|
|
2639
2639
|
title?: string;
|
|
2640
2640
|
description?: string;
|
|
2641
2641
|
version?: string;
|
|
2642
2642
|
};
|
|
2643
2643
|
/**
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
|
|
2644
|
+
* OpenAPI json route
|
|
2645
|
+
*
|
|
2646
|
+
* Default is `/_openapi.json`
|
|
2647
|
+
*/
|
|
2648
2648
|
route?: string;
|
|
2649
2649
|
/**
|
|
2650
|
-
|
|
2651
|
-
|
|
2650
|
+
* Enable OpenAPI generation for production builds
|
|
2651
|
+
*/
|
|
2652
2652
|
production?: false | "runtime" | "prerender";
|
|
2653
2653
|
/**
|
|
2654
|
-
|
|
2655
|
-
|
|
2654
|
+
* UI configurations
|
|
2655
|
+
*/
|
|
2656
2656
|
ui?: {
|
|
2657
2657
|
/**
|
|
2658
|
-
|
|
2659
|
-
|
|
2658
|
+
* Scalar UI configuration
|
|
2659
|
+
*/
|
|
2660
2660
|
scalar?: false | (Partial<unknown> & {
|
|
2661
2661
|
/**
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2662
|
+
* Scalar UI route
|
|
2663
|
+
*
|
|
2664
|
+
* Default is `/_scalar`
|
|
2665
|
+
*/
|
|
2666
2666
|
route?: string;
|
|
2667
2667
|
});
|
|
2668
2668
|
/**
|
|
2669
|
-
|
|
2670
|
-
|
|
2669
|
+
* Swagger UI configuration
|
|
2670
|
+
*/
|
|
2671
2671
|
swagger?: false | {
|
|
2672
2672
|
/**
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
|
|
2676
|
-
|
|
2673
|
+
* Swagger UI route
|
|
2674
|
+
*
|
|
2675
|
+
* Default is `/_swagger`
|
|
2676
|
+
*/
|
|
2677
2677
|
route?: string;
|
|
2678
2678
|
};
|
|
2679
2679
|
};
|
|
@@ -2738,67 +2738,67 @@ interface NitroOptions extends PresetOptions {
|
|
|
2738
2738
|
};
|
|
2739
2739
|
features: {
|
|
2740
2740
|
/**
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2741
|
+
* Enable runtime hooks for request and response.
|
|
2742
|
+
*
|
|
2743
|
+
* By default this feature will be enabled if there is at least one nitro plugin.
|
|
2744
|
+
*/
|
|
2745
2745
|
runtimeHooks?: boolean;
|
|
2746
2746
|
/**
|
|
2747
|
-
|
|
2748
|
-
|
|
2747
|
+
* Enable WebSocket support
|
|
2748
|
+
*/
|
|
2749
2749
|
websocket?: boolean;
|
|
2750
2750
|
};
|
|
2751
2751
|
/**
|
|
2752
|
-
|
|
2753
|
-
|
|
2754
|
-
|
|
2752
|
+
*
|
|
2753
|
+
* @see https://github.com/unjs/unwasm
|
|
2754
|
+
*/
|
|
2755
2755
|
wasm?: false | UnwasmPluginOptions;
|
|
2756
2756
|
openAPI?: NitroOpenAPIConfig;
|
|
2757
2757
|
experimental: {
|
|
2758
2758
|
openAPI?: boolean;
|
|
2759
2759
|
/**
|
|
2760
|
-
|
|
2761
|
-
|
|
2760
|
+
* See https://github.com/microsoft/TypeScript/pull/51669
|
|
2761
|
+
*/
|
|
2762
2762
|
typescriptBundlerResolution?: boolean;
|
|
2763
2763
|
/**
|
|
2764
|
-
|
|
2765
|
-
|
|
2764
|
+
* Enable native async context support for useRequest()
|
|
2765
|
+
*/
|
|
2766
2766
|
asyncContext?: boolean;
|
|
2767
2767
|
/**
|
|
2768
|
-
|
|
2769
|
-
|
|
2768
|
+
* Disable Experimental Sourcemap Minification
|
|
2769
|
+
*/
|
|
2770
2770
|
sourcemapMinify?: false;
|
|
2771
2771
|
/**
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
|
-
|
|
2775
|
-
|
|
2772
|
+
* Allow env expansion in runtime config
|
|
2773
|
+
*
|
|
2774
|
+
* @see https://github.com/nitrojs/nitro/pull/2043
|
|
2775
|
+
*/
|
|
2776
2776
|
envExpansion?: boolean;
|
|
2777
2777
|
/**
|
|
2778
|
-
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
|
|
2782
|
-
|
|
2783
|
-
|
|
2778
|
+
* Enable WebSocket support
|
|
2779
|
+
*
|
|
2780
|
+
* @see https://nitro.build/guide/websocket
|
|
2781
|
+
*
|
|
2782
|
+
* @deprecated use `features.websocket` instead.
|
|
2783
|
+
*/
|
|
2784
2784
|
websocket?: boolean;
|
|
2785
2785
|
/**
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
|
|
2786
|
+
* Enable experimental Database support
|
|
2787
|
+
*
|
|
2788
|
+
* @see https://nitro.build/guide/database
|
|
2789
|
+
*/
|
|
2790
2790
|
database?: boolean;
|
|
2791
2791
|
/**
|
|
2792
|
-
|
|
2793
|
-
|
|
2794
|
-
|
|
2795
|
-
|
|
2792
|
+
* Enable experimental Tasks support
|
|
2793
|
+
*
|
|
2794
|
+
* @see https://nitro.build/guide/tasks
|
|
2795
|
+
*/
|
|
2796
2796
|
tasks?: boolean;
|
|
2797
2797
|
/**
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2798
|
+
* Infer path aliases from tsconfig.json
|
|
2799
|
+
*
|
|
2800
|
+
* @default true
|
|
2801
|
+
*/
|
|
2802
2802
|
tsconfigPaths?: boolean;
|
|
2803
2803
|
};
|
|
2804
2804
|
future: {
|
|
@@ -2849,8 +2849,8 @@ interface NitroOptions extends PresetOptions {
|
|
|
2849
2849
|
devErrorHandler: NitroErrorHandler;
|
|
2850
2850
|
prerender: {
|
|
2851
2851
|
/**
|
|
2852
|
-
|
|
2853
|
-
|
|
2852
|
+
* Prerender HTML routes within subfolders (`/test` would produce `/test/index.html`)
|
|
2853
|
+
*/
|
|
2854
2854
|
autoSubfolderIndex?: boolean;
|
|
2855
2855
|
concurrency?: number;
|
|
2856
2856
|
interval?: number;
|
|
@@ -2860,14 +2860,14 @@ interface NitroOptions extends PresetOptions {
|
|
|
2860
2860
|
ignoreUnprefixedPublicAssets?: boolean;
|
|
2861
2861
|
routes?: string[];
|
|
2862
2862
|
/**
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2863
|
+
* Amount of retries. Pass Infinity to retry indefinitely.
|
|
2864
|
+
* @default 3
|
|
2865
|
+
*/
|
|
2866
2866
|
retry?: number;
|
|
2867
2867
|
/**
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2868
|
+
* Delay between each retry in ms.
|
|
2869
|
+
* @default 500
|
|
2870
|
+
*/
|
|
2871
2871
|
retryDelay?: number;
|
|
2872
2872
|
};
|
|
2873
2873
|
builder?: "rollup" | "rolldown" | "vite";
|
|
@@ -2893,16 +2893,16 @@ interface NitroOptions extends PresetOptions {
|
|
|
2893
2893
|
generateTsConfig?: boolean;
|
|
2894
2894
|
tsConfig?: Partial<TSConfig>;
|
|
2895
2895
|
/**
|
|
2896
|
-
|
|
2897
|
-
|
|
2898
|
-
|
|
2899
|
-
|
|
2896
|
+
* Path of the generated types directory.
|
|
2897
|
+
*
|
|
2898
|
+
* Default is `node_modules/.nitro/types`
|
|
2899
|
+
*/
|
|
2900
2900
|
generatedTypesDir?: string;
|
|
2901
2901
|
/**
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2902
|
+
* Path of the generated `tsconfig.json` relative to `typescript.generatedTypesDir`
|
|
2903
|
+
*
|
|
2904
|
+
* Default is `tsconfig.json` (`node_modules/.nitro/types/tsconfig.json`)
|
|
2905
|
+
*/
|
|
2906
2906
|
tsconfigPath?: string;
|
|
2907
2907
|
};
|
|
2908
2908
|
hooks: NestedHooks<NitroHooks>;
|
|
@@ -2945,10 +2945,10 @@ interface PublicAssetDir {
|
|
|
2945
2945
|
maxAge: number;
|
|
2946
2946
|
dir: string;
|
|
2947
2947
|
/**
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
|
|
2948
|
+
* Pass false to disable ignore patterns when scanning the directory, or
|
|
2949
|
+
* pass an array of glob patterns to ignore (which will override global
|
|
2950
|
+
* nitro.ignore patterns).
|
|
2951
|
+
*/
|
|
2952
2952
|
ignore?: false | string[];
|
|
2953
2953
|
}
|
|
2954
2954
|
interface CompressOptions {
|
|
@@ -3031,6 +3031,7 @@ interface NitroImportMeta {
|
|
|
3031
3031
|
runtimeConfig?: Record<string, any>;
|
|
3032
3032
|
_asyncContext?: boolean;
|
|
3033
3033
|
_tasks?: boolean;
|
|
3034
|
+
_websocket?: boolean;
|
|
3034
3035
|
}
|
|
3035
3036
|
declare global {
|
|
3036
3037
|
interface ImportMeta extends NitroImportMeta {}
|