Type Alias TMarkdownBase

TMarkdownBase: {
    dump(content: string, options: IMarkdownDumpOptions): Promise<void>;
    waitForInit(initial: boolean): Promise<void>;
}

Base interface for markdown storage adapters. All markdown adapters must implement this interface.

Type declaration

  • dump:function
    • Dump markdown content to storage.

      Parameters

      • content: string

        Markdown content to write

      • options: IMarkdownDumpOptions

        Metadata and path options for the dump

      Returns Promise<void>

      Promise that resolves when write is complete

      Error if write fails or stream is not initialized

  • waitForInit:function
    • Initialize markdown storage and prepare for writes. Uses singleshot to ensure one-time execution.

      Parameters

      • initial: boolean

        Whether this is the first initialization

      Returns Promise<void>

      Promise that resolves when initialization is complete