Skip to content

Commit c14c45b

Browse files
committed
Redesign
1 parent 2242262 commit c14c45b

16 files changed

+2966
-3829
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/*.log
22
/.project
3+
/.vscode
34
/.idea
45
/.c9
56
/.codio

README.md

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,36 +17,10 @@ npm install --save js-messages
1717

1818
js-messages currently consists of two functions:
1919

20-
- `defineMessage`: To define one type of message / to create one message creator
21-
- `defineMessages`: To define multiple related messages / to create multipe message creators
20+
- `defineMessages`: To define multiple related messages represented by message creators
2221

2322

24-
Example 1 (using `defineMessage`)
25-
26-
```javascript
27-
import { defineMessage } from 'js-messages'
28-
29-
const
30-
increment = defineMessage('increment'),
31-
// for messages of shape { type: 'increment' }
32-
33-
decrement = defineMessage('decrement'),
34-
// for messages of shape { type: 'decrement' }
35-
36-
resetTo = defineMessage('resetTo', (value: number) => value)
37-
// for messages of shape { type: 'resetTo', payload: number }
38-
39-
expect(increment())
40-
.to.eql({ type: 'increment' })
41-
42-
expect(decrement())
43-
.to.eql({ type: 'decrement' })
44-
45-
expect(resetTo(0))
46-
.to.eql({ type: 'resetTo', payload: 0 })
47-
```
48-
49-
Example 2 (using `defineMessages`):
23+
Example 1:
5024

5125
```javascript
5226
import { defineMessages } from 'js-messages'
@@ -90,7 +64,7 @@ expect(Actions.resetType.type).to.eql('resetTo')
9064
expect(Actions.log.type).to.eql('log')
9165
```
9266

93-
Example 3 (using `defineMessages`):
67+
Example 2:
9468

9569
```javascript
9670
import { defineMessages } from 'js-messages'

0 commit comments

Comments
 (0)