Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
shamrin committed Apr 14, 2016
1 parent 57c25c2 commit 660ac2d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,16 @@ Immutable(new Square(2), {prototype: Square.prototype}).area();

Beyond [the usual Object fare](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object#Methods_of_Object_instances), the following methods have been added.

### Stack overflow protection

Currently you can't construct Immutable from an object with circular references. During development we provide a simple protection by [stopping at suspiciously deep stack level][deep]. If you objects are deep, but not circular, you can increase this level from default `64`. For example:

```javascript
Immutable(deepObject, null, 256);
```

[deep]: https://github.com/rtfeldman/seamless-immutable/wiki/Deeply-nested-object-was-detected

### merge

```javascript
Expand Down

0 comments on commit 660ac2d

Please sign in to comment.