Skip to content

Commit 540b8d5

Browse files
committed
Add a table of contents to the README
1 parent bc7a5c2 commit 540b8d5

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,23 @@ const {
2525
chai.use(require('./chai-immutable'));
2626
-->
2727

28+
## Assertions
29+
30+
- BDD API Reference (Expect / Should)
31+
- [`.empty`](#empty)
32+
- [`.equal(collection)`](#equalcollection)
33+
- [`.referenceEqual(value)`](#referenceequalvalue)
34+
- [`.include(value)`](#includevalue)
35+
- [`.keys(key1[, key2[, ...]])`](#keyskey1-key2-)
36+
- [`.property(path[, val])`](#propertypath-val)
37+
- [`.size(value)`](#sizevalue)
38+
- TDD API Reference (Assert)
39+
- [`.equal(actual, expected)`](#equalactual-expected)
40+
- [`.referenceEqual(actual, expected)`](#referenceequalactual-expected)
41+
- [`.notEqual(actual, expected)`](#notequalactual-expected)
42+
- [`.notReferenceEqual(actual, expected)`](#notreferenceequalactual-expected)
43+
- [`.sizeOf(collection, length)`](#sizeofcollection-length)
44+
2845
## Installation
2946

3047
### Node.js
@@ -95,7 +112,7 @@ expect(Promise.resolve(List.of(1, 2, 3))).to.eventually.have.size(3);
95112
expect(true).to.be.true();
96113
```
97114

98-
## BDD API Reference
115+
## BDD API Reference (Expect / Should)
99116

100117
### .empty
101118

@@ -365,7 +382,7 @@ Similarly to `length`/`lengthOf`, `sizeOf` is an alias of `size`:
365382
expect(List.of(1, 2, 3)).to.have.sizeOf(3);
366383
```
367384

368-
## TDD API Reference
385+
## TDD API Reference (Assert)
369386

370387
### .equal(actual, expected)
371388

0 commit comments

Comments
 (0)