From f6fef16a02dbf7ad43fa6f103e6f74093e09c457 Mon Sep 17 00:00:00 2001 From: Anton Korzunov Date: Sun, 22 Jul 2018 11:41:30 +1000 Subject: [PATCH] block mutations on proxy object --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a7f3822..45d8fc5 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ The difference between proxyEqual and proxyShallow is in _expectations_. * proxyShallow is similar to `shallowEqual`, it compares the top level objects. Might be they are still the same. * proxyEqual working on variable-value level, performing (very) deep comparison of objects. +## Extra API +- `spreadGuardsEnabled(boolean=[true])` - controls spread guards, or all-keys-enumeration, which makes proxyEqual ineffective. +- `sourceMutationsEnabled(boolean=[false])` - controls set behavior. By default proxied state is frozen. + ## When to use proxyequal When you have a big state, for example redux state, but some function (redux selector, or mapStateToProps) uses just a small subset.