Skip to content

Commit

Permalink
[squash] add initial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maclover7 committed Sep 8, 2017
1 parent 4388c22 commit 3e5e2e2
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions test/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@ This directory contains modules used to test the Node.js implementation.

## Table of Contents

* [Benchmark module](#benchmark-module)
* [Common module API](#common-module-api)
* [WPT module](#wpt-module)

## Benchmark Module

The `benchmark` module is used by tests to run benchmarks.

### runBenchmark(name, args, env)

* `name` [<String>] Name of benchmark suite to be run.
* `args` [<Array>] Array of environment variable key/value pairs (ex:
`n=1`) to be applied via `--set`.
* `env` [<Object>] Environment variables to be applied during the run.

## Common Module API

The `common` module is used by tests for consistency across repeated
Expand Down

0 comments on commit 3e5e2e2

Please sign in to comment.