Skip to content

Commit 4ff51ab

Browse files
Merge branch 'master' into eugene-matvejev-patch-1
2 parents 9d48f57 + 6711dd4 commit 4ff51ab

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,23 @@
1515
allows overwrite object field value using abstract path
1616

1717
## software requirements
18-
* node.js 6.9+ [with v8 enabled]
19-
* npm 3+
18+
* node.js v6.9+ [with v8 enabled]
19+
* npm v3+
2020

2121
## used technologies
22-
* jest
22+
* jest _[for tests only]_
2323

2424
## how to execute tests
25-
```
26-
npm test
27-
```
28-
to execute tests with coverage
29-
```
30-
npm test -- --coverage
31-
```
25+
`npm test` or, to execute tests with coverage `npm test -- --coverage`
3226

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

3530
```
36-
import overwriteObjectField from "node-object-field-resolver"
37-
# or, if you use pure node.js:
38-
const overwriteObjectField = require("node-object-field-resolver");
39-
40-
...
4131
let object = {xxx: 'value'} # given object
4232
43-
object = overwriteObjectField('xxx.yyy', object, 'new value', '.'); # result: object ~ {xxx: { yyy: 'new value'} }
33+
object = resolve('xxx.yyy', object, 'new value', '.'); -> result: object ~ {xxx: { yyy: 'new value'} }
4434
4535
can be used as well as:
46-
overwriteObjectField('xxx.yyy', object, 'new value') # as objects are passed as via reference and get modified in proccess
47-
36+
resolve('xxx.yyy', object, 'new value') -> as objects are passed as reference and get modified in proccess
4837
```

0 commit comments

Comments
 (0)