Class MarkdownFolderBase

Folder-based markdown adapter with separate files per report.

Features:

Writes each markdown report as a separate .md file
File path based on options.path and options.file
Automatic directory creation
No stream management (direct writeFile)
Suitable for human-readable report directories

File format: {options.path}/{options.file} Example: ./dump/backtest/BTCUSDT_my-strategy_binance_2024-Q1_backtest-1736601234567.md

Use this adapter (default) for organized report directories and manual review.

Implements

TMarkdownBase

Index

Constructors

Properties

Methods

dump waitForInit

Constructors

constructor

new MarkdownFolderBase(markdownName: keyof IMarkdownTarget): MarkdownFolderBase
Creates a new folder-based markdown adapter instance.
Parameters
- markdownName: keyof IMarkdownTarget
  Type of markdown report (backtest, live, walker, etc.)
Returns MarkdownFolderBase
- Defined in types.d.ts:11576

Properties

`Readonly`markdownName

markdownName: keyof IMarkdownTarget

Methods

dump

dump(content: string, options: IMarkdownDumpOptions): Promise<void>
Writes markdown content to a separate file. Creates directory structure automatically. File path is determined by options.path and options.file.
Parameters
- content: string
  Markdown content to write
- options: IMarkdownDumpOptions
  Path and file options for the dump
Returns Promise<void>
Throws
Error if directory creation or file write fails
Implementation of TMarkdownBase.dump
- Defined in types.d.ts:11593

waitForInit

waitForInit(): Promise<void>
No-op initialization for folder adapter. This adapter doesn't need initialization since it uses direct writeFile.

Returns Promise<void>
Promise that resolves immediately
Implementation of TMarkdownBase.waitForInit
- Defined in types.d.ts:11583