Skip to content

Commit

Permalink
Merge pull request #221 from astorije/astorije/toc
Browse files Browse the repository at this point in the history
Add a table of contents to the README
  • Loading branch information
astorije authored Apr 21, 2019
2 parents 9d943d0 + 3d003ec commit b1121e5
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,23 @@ const {
chai.use(require('./chai-immutable'));
-->

## Assertions

- BDD API Reference (Expect / Should)
- [`.empty`](#empty)
- [`.equal(collection)`](#equalcollection)
- [`.referenceEqual(value)`](#referenceequalvalue)
- [`.include(value)`](#includevalue)
- [`.keys(key1[, key2[, ...]])`](#keyskey1-key2-)
- [`.property(path[, val])`](#propertypath-val)
- [`.size(value)`](#sizevalue)
- TDD API Reference (Assert)
- [`.equal(actual, expected)`](#equalactual-expected)
- [`.referenceEqual(actual, expected)`](#referenceequalactual-expected)
- [`.notEqual(actual, expected)`](#notequalactual-expected)
- [`.notReferenceEqual(actual, expected)`](#notreferenceequalactual-expected)
- [`.sizeOf(collection, length)`](#sizeofcollection-length)

## Installation

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

## BDD API Reference
## BDD API Reference (Expect / Should)

### .empty

Expand Down Expand Up @@ -383,7 +400,7 @@ Similarly to `length`/`lengthOf`, `sizeOf` is an alias of `size`:
expect(List.of(1, 2, 3)).to.have.sizeOf(3);
```

## TDD API Reference
## TDD API Reference (Assert)

### .equal(actual, expected)

Expand Down

0 comments on commit b1121e5

Please sign in to comment.