@runloop/api-client - v1.18.1
    Preparing search index...

    Class Axon

    [Beta] Object-oriented interface for working with Axons.

    The Axon class provides a high-level, object-oriented API for managing axons. Axons are event communication channels that support publishing events and subscribing to event streams via server-sent events (SSE).

    import { RunloopSDK } from '@runloop/api-client';

    const runloop = new RunloopSDK();
    const axon = await runloop.axon.create();

    // Publish an event
    await axon.publish({
      event_type: 'task_complete',
      origin: 'AGENT_EVENT',
      payload: JSON.stringify({ result: 'success' }),
      source: 'my-agent',
    });

    // Subscribe to events
    const stream = await axon.subscribeSse();
    for await (const event of stream) {
      console.log(event.event_type, event.payload);
    }

    // Execute SQL queries
    await axon.sql.query({ sql: 'CREATE TABLE tasks (id INTEGER PRIMARY KEY, name TEXT)' });
    const result = await axon.sql.query({ sql: 'SELECT * FROM tasks WHERE id = ?', params: [1] });
    Index

    Properties

    sql

    Accessors

    id

    Methods

    getInfo publish subscribeSse

    Properties

    sql: AxonSqlOps

    Accessors

    Methods

    • [Beta] Get the complete axon data from the API.

      Parameters

      • Optionaloptions: RequestOptions<unknown>

        Request options

      Returns Promise<Runloop.AxonView>

      The axon data

    • [Beta] Subscribe to this axon's event stream via server-sent events.

      Parameters

      Returns Promise<Stream<Runloop.AxonEventView>>

      An async iterable stream of axon events

      const stream = await axon.subscribeSse();
      for await (const event of stream) {
        console.log(`[${event.source}] ${event.event_type}: ${event.payload}`);
      }

    Settings

    Member Visibility

    On This Page

    OverviewQuickstart
    Properties
    Accessors
    Methods