docs for setReporterAutoRun

pactumjs · Sep 10, 2023 · 6d169ca · 6d169ca
1 parent b5ff3eb
commit 6d169ca
Showing 1 changed file with 44 additions and 1 deletion.
diff --git a/docs/api/settings/setReporterAutoRun.md b/docs/api/settings/setReporterAutoRun.md
@@ -1 +1,44 @@
-# setReporterAutoRun
+---
+tags:
+  - reporter autorun
+  - reporter
+---
+# setReporterAutoRun
+
+sets reporter auto run option. Allows to disable reporter run after spec toss.
+
+> Defaults to `true`
+
+## Syntax
+
+```js
+setReporterAutoRun(boolean)
+```
+
+## Usage
+
+### ✅  Correct Usage
+
+```js
+settings.setReporterAutoRun(false)
+```
+
+## Arguments
+
+#### > option (boolean)
+
+Reporter auto run toggle.
+
+## Examples
+
+### Normal
+
+```js
+const { spec, request } = require('pactum');
+
+settings.setReporterAutoRun(false);
+
+await spec()
+  .get('/api/users/1')
+  .expectStatus(200);
+```