Variable MarkdownFileBaseConst

Type declaration

• • new (
        markdownName: keyof IMarkdownTarget,
    ): {
        _baseDir: string;
        _filePath: string;
        _stream: WriteStream | null;
        "[WAIT_FOR_INIT_SYMBOL]": () => Promise<void> & functools_kit.ISingleshotClearable;
        "[WRITE_SAFE_SYMBOL]": (line: string) => Promise<symbol | void>;
        dump(data: string, options: IMarkdownDumpOptions): Promise<void>;
        markdownName: MarkdownName;
        waitForInit(): Promise<void>;
    }

  • Parameters

    • markdownName: keyof IMarkdownTarget

    Returns {
        _baseDir: string;
        _filePath: string;
        _stream: WriteStream | null;
        "[WAIT_FOR_INIT_SYMBOL]": () => Promise<void> & functools_kit.ISingleshotClearable;
        "[WRITE_SAFE_SYMBOL]": (line: string) => Promise<symbol | void>;
        dump(data: string, options: IMarkdownDumpOptions): Promise<void>;
        markdownName: MarkdownName;
        waitForInit(): Promise<void>;
    }

    • _baseDir: string

      Base directory for all JSONL markdown files

    • _filePath: string

      Absolute path to the JSONL file for this markdown type

    • _stream: WriteStream | null

      WriteStream instance for append-only writes, null until initialized

    • [WAIT_FOR_INIT_SYMBOL]: () => Promise<void> & functools_kit.ISingleshotClearable

      Singleshot initialization function that creates directory and stream. Protected by singleshot to ensure one-time execution. Sets up error handler that emits to exitEmitter.

    • [WRITE_SAFE_SYMBOL]: (line: string) => Promise<symbol | void>

      Timeout-protected write function with backpressure handling. Waits for drain event if write buffer is full. Times out after 15 seconds and returns TIMEOUT_SYMBOL.

    • dump:function

      • dump(data: string, options: IMarkdownDumpOptions): Promise<void>

        Writes markdown content to JSONL file with metadata. Appends a single line with JSON object containing:

        • markdownName: Type of report
        • data: Markdown content
        • Search flags: symbol, strategyName, exchangeName, frameName, signalId
        • timestamp: Current timestamp in milliseconds

        Parameters

        • data: string

          Markdown content to write
        • options: IMarkdownDumpOptions

          Path and metadata options

        Returns Promise<void>

        Throws

        Error if stream not initialized or write timeout exceeded

    • ReadonlymarkdownName: MarkdownName

    • waitForInit:function

      • waitForInit(): Promise<void>

        Initializes the JSONL file and write stream. Safe to call multiple times - singleshot ensures one-time execution.

        Returns Promise<void>

        Promise that resolves when initialization is complete