vigiles API reference
    Preparing search index...

    Function experimental_effect

    • Experimental

      Tagged template literal marking a side-effect boundary — usable as an interpolated fragment inside a body / instructions\``:

      prose ## Apply ${effect Side effects are allowed ONLY here: - write ${file("CHANGELOG.md")} - ${cmd("npm publish")} }

      Returns an EffectRegion fragment; compile wraps its rendered body in <!-- vigiles:effect --> markers. Independent of the doc() authoring surface — it does not block on it.

      Experimental (parked P3) — NOT part of the frozen public surface; may change or be removed without a major bump pre-1.0.

      Parameters

      Returns EffectRegion