Skip to content

Commit c326d3d

Browse files
committed
2 parents fd8ce3b + dda6a43 commit c326d3d

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
# redux-actions-assertions
1+
# redux-actions-assertions [![Build Status](https://travis-ci.org/dmitry-zaets/redux-actions-assertions.svg?branch=master)](https://travis-ci.org/dmitry-zaets/redux-actions-assertions)
22

33
Assertions for redux actions testing
44

55
This library add assertions for [redux actions](http://redux.js.org/docs/advanced/AsyncActions.html) testing.
66
It use [redux-mock-store](https://github.com/arnaudbenard/redux-mock-store) to mock redux store.
77

8+
9+
810
## Supported Assertion Frameworks/Libraries:
9-
- [expect](https://github.com/mjackson/expect)
10-
- [chai](https://github.com/chaijs/chai)
11-
- [In Progress] [expect.js](https://github.com/Automattic/expect.js)
12-
- [In Progress] [should](https://github.com/shouldjs/should.js)
13-
- [In Progress] [jasmine](https://github.com/jasmine/jasmine) and [jest](https://github.com/facebook/jest)
11+
- [expect](#expect)
12+
- [chai](#chai)
13+
- [expect.js](#expectjs) [In Progress]
14+
- [should](#should) [In Progress]
15+
- [jasmine and jest](#jasmine-and-jest) [In Progress]
1416

15-
If you have not found assertion framework/library that you are using - you still can use [pure assertion function]().
17+
If you have not found assertion framework/library that you are using - you still can use [pure assertion function](#javascript).
1618

1719
## Installation
1820

@@ -158,7 +160,9 @@ registerAssertions();
158160
#### .to.dispatch.actions(assert.isDispatching)
159161

160162
> `expect(action).to.dispatch.actions(expectedActions, callback)`
163+
161164
> `action.should.dispatch.actions(expectedActions, callback)`
165+
162166
> `assert.isDispatching(action, expectedActions, callback)`
163167
164168
Asserts that when given `action` is dispatched it will dispatch `expectedActions`. `action` can be plain object (action) or function (action creator). `expectedActions` can be can be plain object (action) or function (action creator) or array of objects/functions.
@@ -180,7 +184,9 @@ assert.isDispatching(
180184
#### .with.state(assert.isDispatchingWithState)
181185

182186
> `expect(action).with.state(state).to.dispatch.actions(expectedActions, callback)`
187+
183188
> `action.should.with.state(state).dispatch.actions(expectedActions, callback)`
189+
184190
> `assert.isDispatchingWithState(action, expectedActions, state, callback)`
185191
186192
Asserts that store initialised with `state` before `action` is dispatched.
@@ -243,4 +249,4 @@ var registerAssertions = require('redux-actions-assertions/jasmine').registerAss
243249

244250
// registration
245251
registerAssertions();
246-
```
252+
```

0 commit comments

Comments
 (0)