Function dumpMessages

  • dumpMessages<Data extends object = any>(
        resultId: ResultId,
        history: Message<BaseRole>[],
        result: Data,
        outputDir?: string,
    ): Promise<void>

    Dumps chat history and result data to markdown files in a structured directory.

    Creates a subfolder named after resultId inside outputDir. If the subfolder already exists, the function returns early without overwriting. Writes:

    • 00_system_prompt.md — system messages and output data summary
    • NN_user_message.md — each user message as a separate file
    • NN_llm_output.md — final LLM output data

    Warns via logger if any user message exceeds 30 KB.

    Type Parameters

    • Data extends object = any

    Parameters

    • resultId: ResultId

      Unique identifier for the result (used as subfolder name)

    • history: Message<BaseRole>[]

      Full chat history containing system, user, and assistant messages

    • result: Data

      Structured output data to include in the dump

    • OptionaloutputDir: string

      Base directory for output files (default: ./dump/strategy)

    Returns Promise<void>

    Promise that resolves when all files are written

    Example

    import { dumpMessages } from "backtest-kit";

    await dumpMessages("result-123", history, { profit: 42 });

Settings

Member Visibility