Skip to content
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

docs: indicate 'exports' interface does not work in browsers #5181

Merged
merged 6 commits into from
Oct 30, 2024
Merged

docs: indicate 'exports' interface does not work in browsers #5181

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0409d42
docs: indicate 'exports' interface does not work in browsers
deyjoy Jul 23, 2024
64d647d
docs: move 'exports' interface browser compatibility note to the expo…
deyjoy Aug 18, 2024
ac82f47
docs: remove redundant 'exports' interface note from API.md
deyjoy Aug 18, 2024
7300af3
Apply suggestions from code review
JoshuaKGoldberg Oct 30, 2024
de198cd
Update docs/index.md
JoshuaKGoldberg Oct 30, 2024
e002877
Merge branch 'main' into update-browser-docs
deyjoy Oct 30, 2024
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
6 changes: 5 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1827,7 +1827,11 @@ suite('Array', function () {

### Exports

The **Exports** interface is much like Mocha's predecessor [expresso][]. The keys `before`, `after`, `beforeEach`, and `afterEach` are special-cased, object values are suites, and function values are test-cases:
The **Exports** interface allows for organizing tests in a modular fashion. It is particularly useful in larger projects where test suites can be segmented into different files.

**Note**: The Exports interface is not supported in browser environments. This limitation arises because browsers handle module exports differently from Node.js. If you intend to run tests in a browser, consider using the BDD or TDD interfaces, which are fully supported.

The Exports interface is much like Mocha's predecessor [expresso][]. The keys `before`, `after`, `beforeEach`, and `afterEach` are special-cased, object values are suites, and function values are test-cases:

```js
module.exports = {
Expand Down
Loading