Skip to main content

Runtime API

Breeze plugins run in the QuickJS-NG engine — not Node.js and not a browser. Below are the extra globals provided by the runtime beyond standard ECMAScript.

Global Objects​

Globals available after plugin startup:

  • fetch / Request / Response / Headers
  • AbortController / AbortSignal
  • URL / URLSearchParams
  • Blob / File / FormData
  • structuredClone
  • console
  • crypto
  • TextEncoder / TextDecoder
  • Buffer
  • path
  • native
  • bridge
  • uuidv4
  • Temporal
  • Intl (time-focused subset; see Temporal & Intl)
  • BreezeHtml
  • bytesToBase64 / bytesFromBase64
  • hostCrypto
  • __web

⚠️ Note: fs is not available. breeze-plugin-kit keeps fs type declarations for running plugin code in pure Node.js test environments, but Breeze does not inject an fs API into the real plugin runtime. This is intentional for security: direct host filesystem access is too risky. Plugins should talk to the outside world via fetch and similar network APIs — do not use fs in plugins.

Subchapters​

Choose a focused page below when you need a specific runtime API.

Last updated on