Skip to content

Commit

Permalink
Add synchronous setup note
Browse files Browse the repository at this point in the history
  • Loading branch information
mattphillips committed Oct 12, 2018
1 parent 367e182 commit a0795e4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -476,6 +476,8 @@ Also under the alias: `it.each(table)(name, fn)` and `` it.each`table`(name, fn)

Use `test.each` if you keep duplicating the same test with different data. `test.each` allows you to write the test once and pass data in.

_Note_ `test`s must be defined synchronously this means the `table` cannot be set inside of a `beforeEach` / `beforeAll`.

`test.each` is available with two APIs:

#### 1. `test.each(table)(name, fn, timeout)`
Expand Down Expand Up @@ -560,6 +562,8 @@ Also under the aliases: `it.only.each(table)(name, fn)`, `fit.each(table)(name,

Use `test.only.each` if you want to only run specific tests with different test data.

_Note_ focussed `test`s must be defined synchronously this means the `table` cannot be set inside of a `beforeEach` / `beforeAll`.

`test.only.each` is available with two APIs:

#### `test.only.each(table)(name, fn)`
Expand Down Expand Up @@ -622,6 +626,8 @@ Also under the aliases: `it.skip.each(table)(name, fn)`, `xit.each(table)(name,

Use `test.skip.each` if you want to stop running a collection of data driven tests.

_Note_ skipped `test`s must be defined synchronously this means the `table` cannot be set inside of a `beforeEach` / `beforeAll`.

`test.skip.each` is available with two APIs:

#### `test.skip.each(table)(name, fn)`
Expand Down

0 comments on commit a0795e4

Please sign in to comment.