cloudflare/miniflare v1.0.0

on GitHub

Breaking Changes

• The first and only argument to the Miniflare constructor is now an object. Scripts should be specified via the script option for strings and the scriptPath option for files:

  // Previous version
  import vm from "vm";
  import { Miniflare } from "miniflare";
  
  const mf1 = new Miniflare(
    new vm.Script(`addEventListener("fetch", (event) => { ... })`),
    { kvPersist: true }
  );
  const mf2 = new Miniflare("script.js", { kvPersist: true });

  // New version
  import { Miniflare } from "miniflare";
  
  const mf1 = new Miniflare({
    script: `addEventListener("fetch", (event) => { ... })`,
    kvPersist: true,
  });
  const mf2 = new Miniflare({
    scriptPath: "script.js",
    kvPersist: true,
  });

• The Miniflare.getNamespace method has been renamed to Miniflare.getKVNamespace

• Logged errors will now throw a MiniflareError if no log is provided

• When using file system KV persistence, key names are now sanitised to replace special characters such as :, /, and \. Reading keys containing these characters may now return null if a value was stored in the previous version.

Features

• Added support for 📚 Modules (requires --experimental-vm-modules flag)
• Added support for 📌 Durable Objects
• Added support for ✉️ Web Sockets (client and server)
• Added support for 🛠 Builds (custom builds and webpack/rust Wrangler builds)
• Added support for ⚙️ WebAssembly
• Added support for 📄 HTMLRewriter
• Made CLI script parameter optional, it can now be inferred in some cases from wrangler.toml
• Added host option (--host/-H flag) for restricting hosts the HTTP server listens on
• Added Miniflare.dispose method for cleaning up file watcher
• Added CF-* headers and cf object to HTTP server requests
• Added cron property to ⏰ Scheduled Events
• Added manual triggering for ⏰ Scheduled Events via /.mf/scheduled HTTP endpoint
• Added pretty error page powered by Youch
• Added many more tests

Fixes

• Fixed error if options object (containing type and cacheTtl properties) passed as second parameter to KV get method, closes issue #3
• Fixed error if ArrayBuffer passed as data to crypto.subtle.digest("md5", data)
• Fixed handling of ignoreMethod option for Cache match and delete
• Disabled edge caching when using Workers Sites, files are now always loaded from disk
• Provide Set and WeakSet from Miniflare's realm to sandbox, removing Promise, so (async () => {})() instanceof Promise evaluates to true