Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Warning about Object.defineProperty to Readme #132

Merged
merged 2 commits into from
Mar 19, 2019

Conversation

fabb
Copy link
Contributor

@fabb fabb commented Jan 3, 2019

No description provided.

@coveralls
Copy link

coveralls commented Jan 3, 2019

Coverage Status

Coverage remained the same at 100.0% when pulling 0b2474e on fabb:patch-1 into 3cab817 on kolodny:master.

README.md Outdated
@@ -138,6 +138,10 @@ be treated as if it was a command object with the `$apply` command:
`update({a: 1}, {a: function})`. That example would be equivalent to
`update({a: 1}, {a: {$apply: function}})`.

### Limitations

:warning: `update` only works for _data properties_, not for _accessor properties_ defined with `Object.defineProperty`. It just does not see the latter, and therefore might create shadowing data properties which could break application logic depending on setter side effects. Therefore `update` should only be used on plain data objects that only contain _data properties_ as decendants.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"descendants"

@kolodny kolodny merged commit 5a86b70 into kolodny:master Mar 19, 2019
@kolodny
Copy link
Owner

kolodny commented Mar 19, 2019

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants