Skip to content

Commit

Permalink
Clarify that cycle checking does not happen in production builds.
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Feldman committed Apr 15, 2016
1 parent 59f0347 commit d424a6d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,16 @@ Beyond [the usual Object fare](https://developer.mozilla.org/en-US/docs/Web/Java

### Stack overflow protection

Currently you can't construct Immutable from an object with circular references. To protect from ugly stack overflows, we provide a simple protection during development. We stop at suspiciously deep stack level and [show an error message][deep].
Currently you can't construct Immutable from an object with circular references. To protect from ugly stack overflows, we provide a simple protection during development. We stop at a suspiciously deep stack level and [show an error message][deep].

If your objects are deep, but not circular, you can increase this level from default `64`. For example:

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

This check is not performed in the production build.

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

### merge
Expand Down

0 comments on commit d424a6d

Please sign in to comment.