Skip to content

Commit

Permalink
doc: move table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelGSS committed Sep 15, 2024
1 parent c4fb290 commit 9451f8d
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,6 @@
The `bench-node` module gives the ability to measure
operations per second of Node.js code block

1. [Install](#install)
2. [Usage](#usage)
3. [class `Suite`](#class-suite)
1. [`suite.add()`](#suiteaddname-options-fn)
2. [`suite.run()`](#suiterun)
4. [Plugins](#plugins)
1. [Structure](#structure)
2. [Plugin Methods](#plugin-methods)
* [`isSupported()` (required)](#issupported-required)
* [`beforeClockTemplate(varNames)`](#beforeclocktemplatevarnames)
* [`afterClockTemplate(varNames)`](#afterclocktemplatevarnames)
* [`onCompleteBenchmark(result)`](#oncompletebenchmarkresult)
* [`toString()` (required)](#tostring-required)
3. [Example Plugins](#example-plugins)
* [V8OptimizeOnNextCallPlugin](#class-v8optimizeonnextcallplugin)
5. [Official Plugins](#official-plugins)
* [Class: `V8OptimizeOnNextCallPlugin`](#class-v8optimizeonnextcallplugin-1)
* [Class: `V8NeverOptimizePlugin`](#class-v8neveroptimizeplugin)
* [Class: `V8GetOptimizationStatus`](#class-v8getoptimizationstatus)
6. [Using custom reporter](#using-custom-reporter)
7. [Setup and Teardown](#setup-and-teardown)

## Install

```console
Expand Down Expand Up @@ -60,6 +38,28 @@ Using delete property x 5,853,505 ops/sec ± 0.01% (10 runs sampled) min..ma

See [examples folder](./examples/) for common usage.

## Table of Contents

1. [class `Suite`](#class-suite)
1. [`suite.add()`](#suiteaddname-options-fn)
2. [`suite.run()`](#suiterun)
2. [Plugins](#plugins)
1. [Structure](#structure)
2. [Plugin Methods](#plugin-methods)
* [`isSupported()` (required)](#issupported-required)
* [`beforeClockTemplate(varNames)`](#beforeclocktemplatevarnames)
* [`afterClockTemplate(varNames)`](#afterclocktemplatevarnames)
* [`onCompleteBenchmark(result)`](#oncompletebenchmarkresult)
* [`toString()` (required)](#tostring-required)
3. [Example Plugins](#example-plugins)
* [V8OptimizeOnNextCallPlugin](#class-v8optimizeonnextcallplugin)
3. [Official Plugins](#official-plugins)
* [Class: `V8OptimizeOnNextCallPlugin`](#class-v8optimizeonnextcallplugin-1)
* [Class: `V8NeverOptimizePlugin`](#class-v8neveroptimizeplugin)
* [Class: `V8GetOptimizationStatus`](#class-v8getoptimizationstatus)
4. [Using custom reporter](#using-custom-reporter)
5. [Setup and Teardown](#setup-and-teardown)

## Class: `Suite`

> Stability: 1.1 Active Development
Expand Down

0 comments on commit 9451f8d

Please sign in to comment.