Documentation
    Preparing search index...
    • Convert the benchmark report to markdown content.

      Processing cost: Rendering delegates to the reporter and scales with report endpoints, samples and output bytes; host metadata is obtained through Node os APIs.

      Platform boundary: The wrapper obtains host information through Node os APIs and passes those facts to the pure renderer without constructing native file paths or shell commands.

      Parameters

      Returns string

      Markdown content

      contracts/common.md#principled-implementation Rendering is a pure function of the report and a few host facts, delegated to the reporter so the report type and its presentation stay separate.

      contracts/common.md#clear-and-simple-design The wrapper captures three native host facts and delegates rendering, giving users one entry point without exposing the internal reporter.

      contracts/common.md#prohibited-implementation-shortcuts The function observes native host facts and formats the report without altering its measurements.

      contracts/common.md#meaningful-documentation The comment states input and output: a report in, markdown content out.