View all results

Embedding

Ferret is designed to run inside host applications. The host owns the runtime lifecycle and decides which parameters, functions, modules, and capabilities an FQL program can use.

Ferret currently supports two embedding environments:

  • Go embedding uses the native github.com/MontFerret/ferret/v2 library. Go applications can configure the complete runtime, including modules, host values, codecs, filesystem access, and execution limits.
  • JavaScript embedding uses @montferret/ferret. The package compiles the Ferret runtime to WebAssembly and exposes it through a JavaScript API for Node.js and modern browsers.

The JavaScript package is not a separate implementation of Ferret. It runs the same Ferret compiler, virtual machine, and standard library through the WASM build.

Choose the host environment in which your application runs. FQL syntax and language behavior stay the same, while the available host integrations and configuration APIs depend on that environment.

Native library Embed Ferret in Go Configure the complete native runtime and its host capabilities. JavaScript package Embed Ferret in JavaScript Run Ferret through WebAssembly in Node.js and modern browsers. Learn Learn the language basics Understand variables, expressions, collections, control flow, and functions. Script inputs Parameters Use parameters to provide runtime input without hardcoding values in FQL scripts.