Skip to content

Commit

Permalink
Adjust MD alignment
Browse files Browse the repository at this point in the history
  • Loading branch information
vasturiano committed Sep 11, 2023
1 parent c22634d commit 307617e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,12 @@ new SpeedTest({ configOptions })
| <b>restart()</b> | Clears the current results and restarts the measurements from the beginning. |

### Notification Events
| Event Method | Arguments | Description |
|------------------------|--------------------------------------------| :--: |
| <b>onRunningChange</b> | running: <i>boolean</i> | Invoked whenever the test engine starts or stops. The current state is included as a function argument. |
| <b>onResultsChange</b> | { type: <i>string</i> } | Invoked whenever any item changes in the results, usually indicating the completion of a measurement. The type of measurement that changed is included as an info attribute in the function argument. |
| <b>onFinish</b> | results: <i>[Results](#results-object)</i> | Invoked whenever the test engine finishes all the measurements. The final [results object](#results-object) is included as a function argument. |
| <b>onError</b> | error: <i>string</i> | Invoked whenever an error occurs during one of the measurements. The error details are included as a function argument. |
| Event Method | Arguments | Description |
| --- | --- | --- |
| <b>onRunningChange</b> | running: <i>boolean</i> | Invoked whenever the test engine starts or stops. The current state is included as a function argument. |
| <b>onResultsChange</b> | { type: <i>string</i> } | Invoked whenever any item changes in the results, usually indicating the completion of a measurement. The type of measurement that changed is included as an info attribute in the function argument. |
| <b>onFinish</b> | results: <i>[Results](#results-object)</i> | Invoked whenever the test engine finishes all the measurements. The final [results object](#results-object) is included as a function argument. |
| <b>onError</b> | error: <i>string</i> | Invoked whenever an error occurs during one of the measurements. The error details are included as a function argument. |

### Measurement config
The specific measurements to be performed by the test engine (and their sequence) can be customized using the `measurements` config option. This should be an array of objects, each with a `type` field, plus additional fields specific to that measurement type.
Expand Down Expand Up @@ -158,4 +158,4 @@ An instance object used to access the results of the speedtest measurements. The
[build-size-img]: https://img.shields.io/bundlephobia/minzip/@cloudflare/speedtest
[build-size-url]: https://bundlephobia.com/result?p=@cloudflare/speedtest
[npm-downloads-img]: https://img.shields.io/npm/dt/@cloudflare/speedtest
[npm-downloads-url]: https://www.npmtrends.com/@cloudflare/speedtest
[npm-downloads-url]: https://www.npmtrends.com/@cloudflare/speedtest

0 comments on commit 307617e

Please sign in to comment.