Skip to content
Registry

iii-stream

v0.11.6-next.5

Build durable streams for real-time data subscriptions.

Engine module
Baked into the iii engine; no separate install required.

Install

bash
iii trigger compose::add worker=iii-stream@0.11.6-next.5

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions8

stream::delete

Function

Delete a value from a stream

Request
  • group_idstringrequired
  • item_idstringrequired
  • stream_namestringrequired
Response
  • old_valueunknown

    The value before the update (None if key didn't exist)

stream::get

Function

Get a value from a stream

Request
  • group_idstringrequired
  • item_idstringrequired
  • stream_namestringrequired
Response
valueunknown

stream::list

Function

List all items in a stream group

Request
  • group_idstringrequired
  • stream_namestringrequired
Response
valueunknown

stream::list_all

Function

List all available stream with metadata

Request
Empty object
Response
  • countinteger· uintrequiredmin 0
  • streamobject[]required
    • groupsstring[]required
    • idstringrequired

stream::list_groups

Function

List all groups in a stream

Request
  • stream_namestringrequired
Response
valueunknown

stream::send

Function

Send a custom event to stream subscribers

Request
  • dataunknownrequired
  • group_idstringrequired
  • idstring
  • stream_namestringrequired
  • typestringrequired
Response
valueunknown

stream::set

Function

Set a value in a stream

Request
  • dataunknownrequired
  • group_idstringrequired
  • item_idstringrequired
  • stream_namestringrequired
Response
  • new_valueunknownrequired

    The value after the update

  • old_valueunknown

    The value before the update (None if key didn't exist)

stream::update

Function

Atomically update a stream value with multiple operations

Request
  • group_idstringrequired
  • item_idstringrequired
  • opsone of[]required
    one of (6)
    Variant 1
    • pathstringrequired

      Represents a path to a field in a JSON object

    • typestringrequiredenum set
    • valueunknown
    Variant 2
    • pathany of
      Show 2 nested
      any of (2)
      Variant 1
      any of (2)
      Variant 1
      valuestring
      Variant 2
      itemsstring[]
      Variant 2
      valuenull
    • typestringrequiredenum merge
    • valueunknownrequired
    Variant 3
    • byinteger· int64required
    • pathstringrequired

      Represents a path to a field in a JSON object

    • typestringrequiredenum increment
    Variant 4
    • byinteger· int64required
    • pathstringrequired

      Represents a path to a field in a JSON object

    • typestringrequiredenum decrement
    Variant 5
    • pathstringrequired

      Represents a path to a field in a JSON object

    • typestringrequiredenum append
    • valueunknownrequired
    Variant 6
    • pathstringrequired

      Represents a path to a field in a JSON object

    • typestringrequiredenum remove
  • stream_namestringrequired
Response
  • errorsobject[]

    Errors encountered while applying ops. Successfully applied ops are still reflected in `new_value`. Field is omitted from JSON when empty for backward compatibility.

    • codestringrequired

      Stable error code, e.g. `"merge.path.too_deep"`.

    • doc_urlstring

      Optional documentation URL for this error class.

    • messagestringrequired

      Human-readable description with concrete numbers when applicable.

    • op_indexinteger· uintrequiredmin 0

      Index of the offending op within the original `ops` array.

  • new_valueunknownrequired

    The value after the update

  • old_valueunknown

    The value before the update (None if key didn't exist)

Triggers3

stream:join

Trigger

Stream join trigger

Invocation
  • condition_function_idstring

    Optional function ID to evaluate before invoking handler

  • stream_namestring

    Stream name to watch

Return
  • event_typestringrequired

    Event type (stream:join or stream:leave)

  • group_idstringrequired

    Group ID

  • idstring

    Peer ID

  • stream_namestringrequired

    Stream name

  • timestampinteger· int64required

    Event timestamp (ms)

stream:leave

Trigger

Stream leave trigger

Invocation
  • condition_function_idstring

    Optional function ID to evaluate before invoking handler

  • stream_namestring

    Stream name to watch

Return
  • event_typestringrequired

    Event type (stream:join or stream:leave)

  • group_idstringrequired

    Group ID

  • idstring

    Peer ID

  • stream_namestringrequired

    Stream name

  • timestampinteger· int64required

    Event timestamp (ms)

stream

Trigger

Stream trigger

Invocation
  • condition_function_idstring

    Optional function ID to evaluate before invoking handler

  • group_idstring

    Group ID filter

  • item_idstring

    Item ID filter

  • stream_namestring

    Stream name to watch

Return
  • eventunknownrequired

    Event-specific data (create/update/delete/sync payload)

  • event_typestringrequired

    Stream event type (create, update, delete, sync)

  • group_idstringrequired

    Group ID

  • idstring

    Item ID

  • stream_namestringrequired

    Stream name

  • timestampinteger· int64required

    Event timestamp (ms)

Search the registry

Find workers, kits and executables, or jump to a page.