Function dumpText

  • dumpText(
        dto: {
            bucketName: string;
            content: string;
            description: string;
            dumpId: string;
        },
    ): Promise<void>

    Dumps raw text content scoped to the current signal.

    Resolves the active pending or scheduled signal automatically from execution context. Automatically detects backtest/live mode from execution context.

    Parameters

    • dto: { bucketName: string; content: string; description: string; dumpId: string }
      • bucketName: string

        Bucket name grouping dumps by strategy or agent name

      • content: string

        Arbitrary text content to persist

      • description: string

        Human-readable label describing the content; included in the BM25 index for Memory search

      • dumpId: string

        Unique identifier for this dump entry

    Returns Promise<void>

    Promise that resolves when the dump is complete

    Throws

    Error if no pending or scheduled signal exists

    Example

    import { dumpText } from "backtest-kit";

    await dumpText({ bucketName: "my-strategy", dumpId: "summary", content: "Agent concluded: bullish", description: "Agent final summary" });

Settings

Member Visibility