Skip to content

Commit

Permalink
doc: fix md links
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelGSS authored Oct 21, 2024
1 parent c6bcf6f commit 522bcca
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@ See the [examples folder](./examples/) for more common usage examples.
1. [`suite.add()`](#suiteaddname-options-fn)
2. [`suite.run()`](#suiterun)
2. [Plugins](#plugins)
3. [Using Custom Reporter](#using-custom-reporter)
3. [Using Reporter](#using-reporter)
1. [Text Reporter](#textreport-default)
2. [Chart Reporter](#chartreport)
3. [Custom Reporter](#custom-reporter)
4. [Setup and Teardown](#setup-and-teardown)
1. [Managed Benchmarks](#managd-benchmarks)
1. [Managed Benchmarks](#managed-benchmarks)

## Class: `Suite`

Expand All @@ -55,9 +58,9 @@ A `Suite` manages and executes benchmark functions. It provides two methods: `ad

### `new Suite([options])`

* `options` {Object} Configuration options for the suite. Supported properties:
* `options` {Object} Configuration options for the suite.
* `reporter` {Function} Callback function for reporting results. Receives one argument:
* `results` {Array<Object>} Contains:
* `results` {Object[]} Array of benchmark results:
* `name` {string} Benchmark name.
* `opsSec` {string} Operations per second.
* `iterations` {Number} Number of iterations.
Expand Down Expand Up @@ -148,13 +151,13 @@ class V8OptimizeOnNextCallPlugin {
}
```

# Using Reporter
## Using Reporter

This module exports two reporters that control how benchmark results are displayed:
a detailed `textReport` for statistical analysis, and a visual `chartReport` that
displays a bar graph in the terminal.

## `textReport` (Default)
### `textReport` (Default)

The `textReport` is the default reporter, which provides detailed statistical information
about each benchmark result. It includes the number of operations per second, the number
Expand Down

0 comments on commit 522bcca

Please sign in to comment.