StrategyMarkdownService

Service for accumulating strategy management events and generating markdown reports.

Collects strategy actions (cancel-scheduled, close-pending, partial-profit, partial-loss, trailing-stop, trailing-take, breakeven) in memory and provides methods to retrieve statistics, generate reports, and export to files.

Unlike StrategyReportService which writes each event to disk immediately, this service accumulates events in ReportStorage instances (max 250 per symbol-strategy pair) for batch reporting.

Features:

• In-memory event accumulation with memoized storage per symbol-strategy pair
• Statistical data extraction (event counts by action type)
• Markdown report generation with configurable columns
• File export with timestamped filenames
• Selective or full cache clearing

Lifecycle:

• Call subscribe() to enable event collection
• Events are collected automatically via cancelScheduled, closePending, etc.
• Use getData(), getReport(), or dump() to retrieve accumulated data
• Call unsubscribe() to disable collection and clear all data

Constructor

constructor();
Copy

Properties

loggerService

loggerService: LoggerService
Copy

getStorage

getStorage: any
Copy

Memoized factory for ReportStorage instances.

Creates and caches ReportStorage per unique symbol-strategy-exchange-frame-backtest combination. Uses CREATE_KEY_FN for cache key generation.

cancelScheduled

cancelScheduled: (symbol: string, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, cancelId?: string) => Promise<...>
Copy

Records a cancel-scheduled event when a scheduled signal is cancelled.

closePending

closePending: (symbol: string, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, closeId?: string) => Promise<...>
Copy

Records a close-pending event when a pending signal is closed.

partialProfit

partialProfit: (symbol: string, percentToClose: number, currentPrice: number, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, totalPartials: number, position: "long" | "short", priceOpen: number, priceTakeProfit: number, price...
Copy

Records a partial-profit event when a portion of the position is closed at profit.

partialLoss

partialLoss: (symbol: string, percentToClose: number, currentPrice: number, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, totalPartials: number, position: "long" | "short", priceOpen: number, priceTakeProfit: number, price...
Copy

Records a partial-loss event when a portion of the position is closed at loss.

trailingStop

trailingStop: (symbol: string, percentShift: number, currentPrice: number, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, totalPartials: number, position: "long" | "short", priceOpen: number, priceTakeProfit: number, priceSt...
Copy

Records a trailing-stop event when the stop-loss is adjusted.

trailingTake

trailingTake: (symbol: string, percentShift: number, currentPrice: number, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, totalPartials: number, position: "long" | "short", priceOpen: number, priceTakeProfit: number, priceSt...
Copy

Records a trailing-take event when the take-profit is adjusted.

breakeven

breakeven: (symbol: string, currentPrice: number, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, totalPartials: number, position: "long" | "short", priceOpen: number, priceTakeProfit: number, priceStopLoss: number, origin...
Copy

Records a breakeven event when the stop-loss is moved to entry price.

activateScheduled

activateScheduled: (symbol: string, currentPrice: number, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, totalPartials: number, position: "long" | "short", priceOpen: number, priceTakeProfit: number, priceStopLoss: number, origin...
Copy

Records an activate-scheduled event when a scheduled signal is activated early.

averageBuy

averageBuy: (symbol: string, currentPrice: number, effectivePriceOpen: number, totalEntries: number, isBacktest: boolean, context: { strategyName: string; exchangeName: string; frameName: string; }, timestamp: number, signalId: string, pnl: IStrategyPnL, totalPartials: number, cost: number, position: "long" | "short", priceOpen...
Copy

Records an average-buy (DCA) event when a new averaging entry is added to an open position.

getData

getData: (symbol: string, strategyName: string, exchangeName: string, frameName: string, backtest: boolean) => Promise<StrategyStatisticsModel>
Copy

Retrieves aggregated statistics from accumulated strategy events.

Returns counts for each action type and the full event list from the ReportStorage for the specified symbol-strategy pair.

getReport

getReport: (symbol: string, strategyName: string, exchangeName: string, frameName: string, backtest: boolean, columns?: Columns[]) => Promise<string>
Copy

Generates a markdown report from accumulated strategy events.

Creates a formatted markdown document containing:

• Header with symbol and strategy name
• Table of all events with configurable columns
• Summary statistics with counts by action type

dump

dump: (symbol: string, strategyName: string, exchangeName: string, frameName: string, backtest: boolean, path?: string, columns?: Columns[]) => Promise<void>
Copy

Generates and saves a markdown report to disk.

Creates the output directory if it doesn't exist and writes the report with a timestamped filename via Markdown.writeData().

Filename format: {symbol}_{strategyName}_{exchangeName}[_{frameName}_backtest|_live]-{timestamp}.md

clear

clear: (payload?: { symbol: string; strategyName: string; exchangeName: string; frameName: string; backtest: boolean; }) => Promise<void>
Copy

Clears accumulated events from storage.

Can clear either a specific symbol-strategy pair or all stored data.

subscribe

subscribe: (() => () => void) & ISingleshotClearable
Copy

Initializes the service for event collection.

Must be called before any events can be collected or reports generated. Uses singleshot pattern to ensure only one subscription exists at a time.

unsubscribe

unsubscribe: () => Promise<void>
Copy

Stops event collection and clears all accumulated data.

Invokes the cleanup function returned by subscribe(), which clears both the subscription and all ReportStorage instances. Safe to call multiple times - only acts if subscription exists.