iii / worker
$worker

iii-stream

v0.11.6-next.6

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
  • 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
  • streamunknown[]required

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
  • opsunknown[]required
  • stream_namestringrequired
response
  • errorsunknown[]

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

  • new_valueunknownrequired

    The value after the update

  • old_valueunknown

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

triggers

3

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)

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)