iii / worker
$worker

configuration

v0.17.0-next.1

Configuration worker for the iii engine.

engine module
baked into the iii engine; no separate install required.

functions

5

configuration::get

function

Read a configuration by id. Expands ${VAR:default} placeholders against the live process env unless raw=true is passed.

request
  • idstringrequired
  • rawboolean

    When `true`, return the stored value verbatim (including `${VAR}` placeholders). When `false` (default), expand `${VAR:default}` against the live process env.

response
  • idstringrequired
  • valueunknownrequired

configuration::list

function

List every registered configuration with id, name, description, and schema. Sorted by id; never returns the stored value.

request
empty object
response
  • configurationsobject[]required
    • descriptionstringrequired
    • idstringrequired
    • metadataunknown
    • namestringrequired
    • schemaunknownrequired

configuration::register

function

Register a configuration id with a name, description, and JSON Schema. Idempotent — re-registering replaces metadata and (when initial_value is provided) the value. Validates initial_value against the schema.

request
  • descriptionstringrequired

    Description shown in `configuration::list`.

  • idstringrequired

    Configuration id. Must match `[a-z0-9_-]{1,64}` so it is safe as a filename in the `fs` adapter.

  • initial_valueunknown

    Optional initial value to install. Validated against `schema`.

  • metadataunknown

    Optional opaque metadata stored alongside the entry.

  • namestringrequired

    Human-readable name shown in `configuration::list`.

  • schemaunknownrequired

    JSON Schema describing the value shape. `set` validates against this.

response
  • descriptionstringrequired

    One-line description of what this configuration controls.

  • idstringrequired

    Stable identifier (e.g. `iii-stream`, `iii-observability`).

  • metadataunknown

    Optional caller-supplied metadata (owner team, change ticket, etc.).

  • namestringrequired

    Human-readable display name.

  • schemaunknownrequired

    JSON Schema describing the shape of `value`.

  • valueunknown

    Stored configuration body. May contain `${VAR:default}` placeholders.

configuration::schema

function

Retrieve the schema, name, and description for a configuration id. Mirrors a single entry from configuration::list.

request
  • idstringrequired
response
  • descriptionstringrequired
  • idstringrequired
  • metadataunknown
  • namestringrequired
  • schemaunknownrequired

configuration::set

function

Replace the value of an already-registered configuration. Validates the value against the registered JSON Schema and emits a configuration:updated event.

request
  • idstringrequired
  • valueunknownrequired

    New configuration value. Validated against the registered schema.

response
  • new_valueunknownrequired

    Current stored value (templates not expanded).

  • old_valueunknown

    Previous stored value, or `null` when the entry had no value yet.

triggers

0
no triggers registered