SheetXL - v1.0.2
    Preparing search index...

    Function renderMarkdown

    • Renders any renderable SDK object as its markdown report.

      Parameters

      • workbook: IWorkbook | null

        The workbook whose calculation settles before the render — the book the target came from. null only for a value with no book behind it (a plain array, a record).

      • target: unknown
      • Optionaloptions: Renderer.Options

      Returns Promise<string>

      Unbranded iterables (a generator a macro returned, find()'s iterator) are materialized — capped — before dispatch, so a bare iterator still renders as whatever its members are. Branded kinds never take this path: getRegions returns a branded collection that happens to be iterable, and flattening it would lose the features it carries.

      Calculation settles here, not in the renderers. A report read before the engine drains is wrong in quiet ways — formula results absent, used ranges short, every name reported unused — which is why the workbook is the FIRST parameter rather than an option a caller can forget. One settle covers every kind (all of a book's sheets, names and formulas share its engine), and it is the whole async surface: the renderers themselves are synchronous, and a caller invoking one directly is responsible for settling first.

      A render can itself start calculation: a cell's effective style reads a conditional format whose whole-column answer is evaluated only where it is read, and the read asks for it. When a render leaves the engine calculating, it settles again and renders again, so the report carries what the first read asked for.

      If no registered renderer accepts the object.