Interface IHistoryInstance

Interface defining methods for a history instance implementation.

interface IHistoryInstance {
    dispose(agentName: string): Promise<void>;
    iterate(agentName: string): AsyncIterableIterator<IModelMessage<object>>;
    pop(agentName: string): Promise<IModelMessage<object>>;
    push(value: IModelMessage, agentName: string): Promise<void>;
    waitForInit(agentName: string, init: boolean): Promise<void>;
}

Methods

dispose iterate pop push waitForInit

Methods

dispose

  • dispose(agentName: string): Promise<void>

    Disposes of the history for an agent, optionally clearing all data.

    Parameters

    • agentName: string

      The name of the agent, or null to dispose fully.

    Returns Promise<void>

    A promise that resolves when disposal is complete.

iterate

  • iterate(agentName: string): AsyncIterableIterator<IModelMessage<object>>

    Iterates over history messages for an agent.

    Parameters

    • agentName: string

      The name of the agent.

    Returns AsyncIterableIterator<IModelMessage<object>>

    An async iterator yielding history messages.

pop

  • pop(agentName: string): Promise<IModelMessage<object>>

    Removes and returns the last message from the history for an agent.

    Parameters

    • agentName: string

      The name of the agent.

    Returns Promise<IModelMessage<object>>

    The last message, or null if the history is empty.

push

  • push(value: IModelMessage, agentName: string): Promise<void>

    Adds a new message to the history for an agent.

    Parameters

    • value: IModelMessage

      The message to add.

    • agentName: string

      The name of the agent.

    Returns Promise<void>

    A promise that resolves when the message is added.

waitForInit

  • waitForInit(agentName: string, init: boolean): Promise<void>

    Initializes the history for an agent, loading initial data if needed.

    Parameters

    • agentName: string

      The name of the agent.

    • init: boolean

      Whether this is the initial setup (affects caching behavior).

    Returns Promise<void>

    A promise that resolves when initialization is complete.

Settings

Member Visibility

On This Page

Methods