Interface ICustomEvent<T>

Interface representing a custom event with a flexible payload in the swarm system. Extends IBaseEvent for generic event handling, allowing arbitrary data via payload, though not directly observed in ClientAgent (which uses IBusEvent). Likely used for bespoke event scenarios outside the structured IBusEvent schema, dispatched via IBus.emit.

interface ICustomEvent<T extends any = any> {
    clientId: string;
    payload?: T;
    source: string;
}

Type Parameters

  • T extends any = any

Hierarchy (View Summary)

Properties

clientId payload? source

Properties

clientId

clientId: string

The unique identifier of the client targeted by the event. Matches the clientId used in runtime params (e.g., this.params.clientId in ClientAgent), ensuring events reach the intended session or agent instance. Example: "client-123" for a user session receiving an "emit-output" event.

Optionalpayload

payload?: T

The optional payload of the event, carrying custom data of any type. Provides flexibility for event-specific information, unlike IBusEvent’s rigid input/output structure, potentially for user-defined events. Example: { status: "complete", data: 42 } for a custom completion event.

Template: T

The type of the payload, defaulting to any for maximum flexibility.

source

source: string

The source of the event, identifying its origin within the system. A generic string (EventSource) in IBaseEvent, overridden by EventBusSource in IBusEvent (e.g., "agent-bus" in ClientAgent). Example: "custom-source" for a basic event, or "agent-bus" in practice.

Settings

Member Visibility

On This Page

Properties