Function makeConnection

A connection factory for establishing a client connection to a swarm, returning a function to send messages.

This factory creates a queued connection to the swarm, allowing the client to send messages to the active agent. It is designed for real-time communication, leveraging the session public service for message handling.

Throws

If swarm or session validation fails, or if the connection process encounters an error.

Example

const sendMessage = makeConnection((msg) => console.log(msg), "client-123", "TaskSwarm");
await sendMessage("Hello, swarm!");
  • makeConnection<Payload extends object = object>(
        connector: ReceiveMessageFn,
        clientId: string,
        swarmName: string,
    ): (content: string, payload?: Payload) => Promise<void>

    Type Parameters

    • Payload extends object = object

    Parameters

    • connector: ReceiveMessageFn

      The function to receive incoming messages from the swarm.

    • clientId: string

      The unique identifier of the client session.

    • swarmName: string

      The name of the swarm to connect to.

    Returns (content: string, payload?: Payload) => Promise<void>

    A function to send messages to the swarm.

Methods

rate scheduled

Methods

rate

  • rate<Payload extends object = object>(
        connector: ReceiveMessageFn,
        clientId: string,
        swarmName: string,
        config?: Partial<IMakeConnectionConfig>,
    ): (content: string, payload?: Payload) => Promise<void | "">

    A rate-limited connection factory for a client to a swarm, returning a function to send throttled messages.

    This factory extends makeConnection by adding rate-limiting capabilities, throttling message sends based on the configured delay. If the rate limit is exceeded, it warns and returns an empty result instead of throwing an error.

    Type Parameters

    • Payload extends object = object

    Parameters

    • connector: ReceiveMessageFn

      The function to receive incoming messages from the swarm.

    • clientId: string

      The unique identifier of the client session.

    • swarmName: string

      The name of the swarm to connect to.

    • Optionalconfig: Partial<IMakeConnectionConfig>

      Configuration object with an optional delay (defaults to RATE_DELAY).

    Returns (content: string, payload?: Payload) => Promise<void | "">

    A function to send rate-limited messages to the swarm.

    Throws

    If swarm or session validation fails, or if the send process encounters a non-rate-limit error.

    Example

    const sendRateLimited = makeConnection.rate((msg) => console.log(msg), "client-123", "TaskSwarm", { delay: 5000 });
    await sendRateLimited("Throttled message"); // Limited to one send every 5 seconds

scheduled

  • scheduled<Payload extends object = object>(
        connector: ReceiveMessageFn,
        clientId: string,
        swarmName: string,
        config?: Partial<IMakeConnectionConfig>,
    ): (content: string, payload?: Payload) => Promise<void>

    A scheduled connection factory for a client to a swarm, returning a function to send delayed messages.

    This factory extends makeConnection by adding scheduling capabilities, delaying message sends based on the configured delay. It commits messages to the agent's history immediately via commitUserMessage and sends them after the delay if the session remains active.

    Type Parameters

    • Payload extends object = object

    Parameters

    • connector: ReceiveMessageFn

      The function to receive incoming messages from the swarm.

    • clientId: string

      The unique identifier of the client session.

    • swarmName: string

      The name of the swarm to connect to.

    • Optionalconfig: Partial<IMakeConnectionConfig>

      Configuration object with an optional delay (defaults to SCHEDULED_DELAY).

    Returns (content: string, payload?: Payload) => Promise<void>

    A function to send scheduled messages to the swarm.

    Throws

    If swarm or session validation fails, or if the scheduled send process encounters an error.

    Example

    const sendScheduled = makeConnection.scheduled((msg) => console.log(msg), "client-123", "TaskSwarm", { delay: 2000 });
    await sendScheduled("Delayed message"); // Sent after 2 seconds

Settings

Member Visibility

On This Page

Methods