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

Jump to bottom

Add documentation for using chai-jquery with an AMD like require.js #68

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add documentation for using chai-jquery with an AMD like require.js #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
524cba5
Add documentation for using chai-jquery with AMD
jvennix-rmn Jul 29, 2015
d7ab8aa
Remove unnecessary comma.
jvennix-rmn Jul 29, 2015
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ Include `chai-jquery.js` in your test file, after `chai.js` (version 1.0.0-rc1 o
<script src="chai-jquery.js"></script>
```

If you are using an AMD like requirejs, you can pull in chai-jquery as a dependency and it will return an initialization function that can be passed to chai:

```js
require([
'chai-jquery'
], function(chaiJquery) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you require chai as well? You don't want to rely on a global instance.

chai.use(chaiJquery);
});
```

Use the assertions with chai's `expect` or `should` assertions.

## Assertions
Expand Down