Skip to content

Commit 34895e0

Browse files
authored
Merge pull request #26 from mrloop/readme
docs: update require / import statements
2 parents 67629d4 + f39f255 commit 34895e0

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ qunit-retry
22
==============================================================================
33

44
[![Latest NPM release][npm-badge]][npm-badge-url]
5-
[![CI](https://github.com/mrloop//qunit-retry/workflows/CI/badge.svg)](https://github.com/mrloop/qunit-retry/actions)
5+
![GitHub branch check runs](https://img.shields.io/github/check-runs/mrloop/qunit-retry/master?logo=github&label=CI)
66

77
[npm-badge]: https://img.shields.io/npm/v/qunit-retry.svg
88
[npm-badge-url]: https://www.npmjs.com/package/qunit-retry
99

1010
Drop in replacement for [QUnit](https://qunitjs.com/) [test](https://api.qunitjs.com/QUnit/test) to `retry` test upon failure.
1111

1212
```js
13-
const setup = require('qunit-retry');
13+
import setup from "qunit-retry";
14+
import QUnit from "qunit";
1415

1516
const retry = setup(QUnit.test);
16-
1717
// retry this test on failure as third party service occasionally fails
1818
// we need to test against third party service
1919
// we can live with occasional third party service failure
@@ -34,7 +34,8 @@ Blog post about `qunit-retry` available [here](https://blog.mrloop.com/javascrip
3434
The default maximum number of retries is 2 (one attempt and one retry). To change it globally, pass the `maxRuns` option to the `setup` function:
3535

3636
```js
37-
const setup = require('qunit-retry');
37+
import setup from "qunit-retry";
38+
import QUnit from "qunit";
3839

3940
const retry = setup(QUnit.test, { maxRuns: 3 });
4041
```
@@ -59,7 +60,8 @@ retry("a test relying on 3rd party service that occasionally fails", async funct
5960
If you need to reset the environment between retries, you can pass a `beforeRetry` function to the `setup` function:
6061

6162
```js
62-
const setup = require('qunit-retry');
63+
import setup from "qunit-retry";
64+
import QUnit from "qunit";
6365

6466
const retry = setup(QUnit.test, { beforeRetry: () => resetEnvironment() });
6567
```
@@ -89,7 +91,8 @@ pnpm add --save-dev qunit-retry
8991
### Node
9092

9193
```js
92-
const setup = require('qunit-retry');
94+
import setup from "qunit-retry";
95+
import QUnit from "qunit";
9396

9497
const retry = setup(QUnit.test);
9598
```

0 commit comments

Comments
 (0)