wrangler.ts

import { CompatibilityFlag } from "./compat";
import { ModuleRuleType } from "./runner";

// See https://developers.cloudflare.com/workers/cli-wrangler/configuration#keys

export interface WranglerEnvironmentConfig {
  name?: string; // inherited
  zone_id?: string; // inherited
  account_id?: string; // inherited
  workers_dev?: boolean; // inherited
  route?: string; // NOT inherited
  routes?: string[]; // NOT inherited
  webpack_config?: string; // inherited
  vars?: Record<string, any>; // NOT inherited
  kv_namespaces?: {
    binding: string;
    id?: string;
    preview_id?: string;
  }[]; // NOT inherited
  site?: {
    bucket: string;
    "entry-point"?: string;
    include?: string[];
    exclude?: string[];
  }; // inherited
  durable_objects?: {
    bindings?: {
      name: string;
      class_name: string;
      script_name?: string;
    }[];
  }; // (probably) NOT inherited
  triggers?: {
    crons?: string[];
  }; // inherited
  usage_model?: "bundled" | "unbound"; // inherited
  wasm_modules?: Record<string, string>; // (probably) inherited
  text_blobs?: Record<string, string>;
  experimental_services?: {
    name: string;
    service: string;
    environment: string;
  }[]; // (probably) NOT inherited
  miniflare?: {
    globals?: Record<string, any>;
    upstream?: string;
    watch?: boolean;
    build_watch_dirs?: string[];
    kv_persist?: boolean | string;
    cache?: boolean;
    cache_persist?: boolean | string;
    durable_objects_persist?: boolean | string;
    env_path?: string;
    host?: string;
    port?: number;
    open?: boolean | string;
    cf_fetch?: boolean | string;
    https?:
      | boolean
      | string
      | {
          key?: string;
          cert?: string;
          ca?: string;
          pfx?: string;
          passphrase?: string;
        };
    live_reload?: boolean;
    update_check?: boolean;
    mounts?: Record<string, string>;
    route?: string;
    routes?: string[];
    global_async_io?: boolean;
    global_timers?: boolean;
    global_random?: boolean;
  }; // inherited
}

export interface WranglerConfig extends WranglerEnvironmentConfig {
  type?: "javascript" | "webpack" | "rust"; // top level
  compatibility_date?: string;
  compatibility_flags?: CompatibilityFlag[];
  build?: {
    command?: string;
    cwd?: string;
    watch_dir?: string;
    upload?: {
      format?: "service-worker" | "modules";
      dir?: string;
      main?: string;
      rules?: {
        type: ModuleRuleType;
        globs: string[];
        fallthrough?: boolean;
      }[];
    };
  }; // top level
  env?: Record<string, WranglerEnvironmentConfig>;
}