Function session

Creates a session for a client and swarm, providing methods to complete and dispose of it.

This factory establishes a session in "session" mode, allowing content execution with queuing for sequential processing. It returns an object with complete to process content and dispose to clean up the session.

Throws

If swarm or session validation fails, or if execution/disposal encounters an error.

Example

const { complete, dispose } = session("client-123", "TaskSwarm");
const result = await complete("Hello, swarm!");
console.log(result); // Outputs the swarm's response
await dispose();
  • session<Payload extends object = object>(
        clientId: string,
        swarmName: string,
        __namedParameters?: Partial<Omit<ISessionConfig, "delay">>,
    ): {
        complete: (content: string, payload?: Payload) => Promise<string>;
        dispose: () => Promise<void>;
    }

    Type Parameters

    • Payload extends object = object

    Parameters

    • clientId: string

      The unique identifier of the client session.

    • swarmName: string

      The name of the swarm to connect to.

    • Optional__namedParameters: Partial<Omit<ISessionConfig, "delay">>

    Returns {
        complete: (content: string, payload?: Payload) => Promise<string>;
        dispose: () => Promise<void>;
    }

    An object with complete and dispose methods.

Methods

rate scheduled

Methods

rate

  • rate<Payload extends object = object>(
        clientId: string,
        swarmName: string,
        config?: Partial<ISessionConfig>,
    ): {
        dispose: () => Promise<void>;
        complete(content: string, payload?: Payload): Promise<string>;
    }

    Creates a rate-limited session for a client and swarm, throttling content execution.

    This factory extends session by adding rate-limiting capabilities, throttling complete calls based on the configured delay. If the rate limit is exceeded, it warns and returns an empty string instead of throwing an error.

    Type Parameters

    • Payload extends object = object

    Parameters

    • clientId: string

      The unique identifier of the client session.

    • swarmName: string

      The name of the swarm to connect to.

    • Optionalconfig: Partial<ISessionConfig>

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

    Returns {
        dispose: () => Promise<void>;
        complete(content: string, payload?: Payload): Promise<string>;
    }

    An object with rate-limited complete and dispose methods.

    Throws

    If swarm or session validation fails, or if execution/disposal encounters a non-rate-limit error.

    Example

    const { complete, dispose } = session.rate("client-123", "TaskSwarm", { delay: 5000 });
    const result = await complete("Throttled message"); // Limited to one execution every 5 seconds
    console.log(result);
    await dispose();

scheduled

  • scheduled<Payload extends object = object>(
        clientId: string,
        swarmName: string,
        config?: Partial<ISessionConfig>,
    ): {
        complete: (content: string, payload?: Payload) => Promise<string>;
        dispose: () => Promise<void>;
    }

    Creates a scheduled session for a client and swarm, delaying content execution.

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

    Type Parameters

    • Payload extends object = object

    Parameters

    • clientId: string

      The unique identifier of the client session.

    • swarmName: string

      The name of the swarm to connect to.

    • Optionalconfig: Partial<ISessionConfig>

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

    Returns {
        complete: (content: string, payload?: Payload) => Promise<string>;
        dispose: () => Promise<void>;
    }

    An object with scheduled complete and dispose methods.

    Throws

    If swarm or session validation fails, or if execution/disposal encounters an error.

    Example

    const { complete, dispose } = session.scheduled("client-123", "TaskSwarm", { delay: 2000 });
    const result = await complete("Delayed message"); // Executed after 2 seconds
    console.log(result);
    await dispose();

Settings

Member Visibility

On This Page

Methods