# unexpected-immutable

[![CircleCI](https://circleci.com/gh/erikmueller/unexpected-immutable.svg?style=svg)](https://circleci.com/gh/erikmueller/unexpected-immutable)

![unexpected-immutable](http://vitiy.info/wp-content/uploads/2015/06/immutability.png)

> Assert (pretty) equality of Immutable.js iterables with unexpected.

This plugin lets you compare [Immutable](https://facebook.github.io/immutable-js/) data structures.

# unexpected-immutable

[![CircleCI](https://circleci.com/gh/erikmueller/unexpected-immutable.svg?style=svg)](https://circleci.com/gh/erikmueller/unexpected-immutable)

![unexpected-immutable](http://vitiy.info/wp-content/uploads/2015/06/immutability.png)

This plugin lets you compare [Immutable](https://facebook.github.io/immutable-js/) data structures, and makes the diff as pretty as all the others are.

## API

### Data types

`Immutable` is the general `Iterable` data type, serving as a base for the others.

`ImmutableKeyed` represents 'object-like' Immutable types, such as `Map`.

`ImmutableIndexed` covers 'array-like' types, such as `List`.

### Assertions

This library provides `to satisfy` assertions for the above data types. It ensures that they can be compared against each other as well as against comparable JavaScript objects (i.e. `{}` or `[]`).

Indexed types also have most of the assertions of `unexpected`s `array-like` data type (in particular `to have items satisfying`), while keyed types will have most of the `object-like` assertions.

Add API section to readme.
Add API section to readme.
