Function dumpTable

  • dumpTable(
        dto: {
            bucketName: string;
            description: string;
            dumpId: string;
            rows: Record<string, unknown>[];
        },
    ): Promise<void>

    Dumps an array of objects as a table scoped to the current signal.

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

    Column headers are derived from the union of all keys across all rows.

    Parameters

    • dto: {
          bucketName: string;
          description: string;
          dumpId: string;
          rows: Record<string, unknown>[];
      }
      • bucketName: string

        Bucket name grouping dumps by strategy or agent name

      • description: string

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

      • dumpId: string

        Unique identifier for this dump entry

      • rows: Record<string, unknown>[]

        Array of arbitrary objects to render as a table

    Returns Promise<void>

    Promise that resolves when the dump is complete

    Throws

    Error if no pending or scheduled signal exists

    Example

    import { dumpTable } from "backtest-kit";

    await dumpTable({ bucketName: "my-strategy", dumpId: "candles", rows: [{ time: 1234, close: 42000 }], description: "Recent candle history" });

Settings

Member Visibility