iii / worker
$worker

iii-stream

v0.11.7-next.4

Build durable streams for real-time data subscriptions.

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

functions

8

stream::delete

function

Delete a value from a stream

request
  • group_idstringrequired

    Group within the stream that owns the item.

  • item_idstringrequired

    Identifier of the item to delete.

  • stream_namestringrequired

    Name of the stream that owns the item.

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

    Group within the stream to read from.

  • item_idstringrequired

    Identifier of the item to fetch.

  • stream_namestringrequired

    Name of the stream to read from.

response
valueunknown

stream::list

function

List all items in a stream group

request
  • group_idstringrequired

    Group within the stream whose items should be listed.

  • stream_namestringrequired

    Name of the stream whose items should be listed.

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

    Name of the stream whose groups should be listed.

response
valueunknown

stream::send

function

Send a custom event to stream subscribers

request
  • dataunknownrequired

    JSON payload delivered to subscribers.

  • group_idstringrequired

    Group within the stream to broadcast to.

  • idstring

    Optional subscriber ID to target a single subscriber instead of the whole group.

  • stream_namestringrequired

    Name of the stream to broadcast to.

  • typestringrequired

    Event type label sent alongside the payload.

response
valueunknown

stream::set

function

Set a value in a stream

request
  • dataunknownrequired

    JSON value to store at the given location.

  • group_idstringrequired

    Group within the stream that owns the item.

  • item_idstringrequired

    Identifier of the item within the group.

  • stream_namestringrequired

    Name of the stream that owns the item.

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

    Group within the stream that owns the item.

  • item_idstringrequired

    Identifier of the item to update.

  • opsone of[]required

    Ordered list of update operations applied atomically to the existing value.

    one of (6)
    variant 1
    • pathstringrequired

      Represents a path to a field in a JSON object

    • typestringrequiredenum: set
    • valueunknown
    variant 2
    • pathany of
      … expand 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
    • pathany of
      … expand 2 nested
      any of (2)
      variant 1
      any of (2)
      variant 1
      valuestring
      variant 2
      itemsstring[]
      variant 2
      valuenull
    • typestringrequiredenum: append
    • valueunknownrequired
    variant 6
    • pathstringrequired

      Represents a path to a field in a JSON object

    • typestringrequiredenum: remove
  • stream_namestringrequired

    Name of the stream that owns the item.

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)

triggers

3

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: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

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)