Skip to content

update README.md #13

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 5, 2017
Merged

update README.md #13

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c121f1e
Update README.md
eugene-matvejev Mar 5, 2017
d3a358f
Merge branch 'master' into eugene-matvejev-patch-2
eugene-matvejev Mar 5, 2017
630a650
Merge branch 'master' into eugene-matvejev-patch-2
eugene-matvejev Mar 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 7 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,23 @@
allows overwrite object field value using abstract path

## software requirements
* node.js 6.9+ [with v8 enabled]
* npm 3+
* node.js v6.9+ [with v8 enabled]
* npm v3+

## used technologies
* jest
* jest _[for tests only]_

## how to execute tests
```
npm test
```
to execute tests with coverage
```
npm test -- --coverage
```
`npm test` or, to execute tests with coverage `npm test -- --coverage`

## how to use
`import resolve from "node-object-field-resolver";` or `const resolve = require("node-object-field-resolver");`

```
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'} # given object

object = overwriteObjectField('xxx.yyy', object, 'new value', '.'); # result: object ~ {xxx: { yyy: 'new value'} }
object = resolve('xxx.yyy', object, 'new value', '.'); -> result: 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

resolve('xxx.yyy', object, 'new value') -> as objects are passed as reference and get modified in proccess
```