Raxol.Benchmark.Formatter (Raxol v2.6.0)

Formats benchmark results as console tables, JSON, or Markdown.

Summary

console(results)

Formats results as a console table string.

Formats results as a JSON string with metadata.

Formats results as a Markdown table.

Writes formatted output to a file.

@spec console(map()) :: String.t()

Formats results as a console table string.

Expects a map of %{suite_name => %Benchee.Suite{}} or raw timing maps.

@spec json(
  map(),
  keyword()
) :: String.t()

Formats results as a JSON string with metadata.

@spec markdown(map()) :: String.t()

Formats results as a Markdown table.

@spec write(String.t(), Path.t()) :: :ok | {:error, term()}

Writes formatted output to a file.