Skip to content

docs: update require / import statements #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrloop merged 1 commit into from
Jan 28, 2025
Merged

docs: update require / import statements #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@ qunit-retry
==============================================================================

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

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

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

```js
const setup = require('qunit-retry');
import setup from "qunit-retry";
import QUnit from "qunit";

const retry = setup(QUnit.test);

// retry this test on failure as third party service occasionally fails
// we need to test against third party service
// we can live with occasional third party service failure
Expand All @@ -34,7 +34,8 @@ Blog post about `qunit-retry` available [here](https://blog.mrloop.com/javascrip
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:

```js
const setup = require('qunit-retry');
import setup from "qunit-retry";
import QUnit from "qunit";

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

```js
const setup = require('qunit-retry');
import setup from "qunit-retry";
import QUnit from "qunit";

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

```js
const setup = require('qunit-retry');
import setup from "qunit-retry";
import QUnit from "qunit";

const retry = setup(QUnit.test);
```
Expand Down