@eagleoutice/flowr - v2.13.2
    Preparing search index...

    Interface OutputFormatter

    interface OutputFormatter {
        format(input: string, options?: FormatOptions): string;
        getFormatString(options?: FormatOptions): string;
        hyperlink(text: string, url: string, force?: boolean): string;
        reset(): string;
    }
    Index

    Methods

    • Render text as a link to url in whatever form this output supports (OSC 8, markdown, or plain text). When a live hyperlink cannot be rendered, the raw url is shown so the target is not lost; pass force to always emit just the short text label instead.

      Parameters

      • text: string
      • url: string
      • Optionalforce: boolean

      Returns string