diff --git a/README.md b/README.md index d95e11e..d3d6588 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,15 @@ npm test -- --coverage ``` import overwriteObjectField from "node-object-field-resolver" +# or, if you use pure node.js: +const overwriteObjectField = require("node-object-field-resolver"); ... -let object = {xxx: 'value'} +let object = {xxx: 'value'} # given object -object = overwriteObjectField('xxx.yyy', object, 'new value', '.'); +object = overwriteObjectField('xxx.yyy', object, 'new value', '.'); # result: object ~ {xxx: { yyy: 'new value'} } -object // {xxx: { yyy: 'new value'} } +can be used as well as: +overwriteObjectField('xxx.yyy', object, 'new value') # as objects are passed as via reference and get modified in proccess ```