Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukasz-pluszczewski committed Jan 28, 2018
2 parents 15c6902 + 2cc8cbc commit 703b328
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- works similar to lodash's `_.set()` or Immutable.js `set()` and `setIn()` but does not mutate the object and accepts plain JS object or array (can be used to easily, immutably set value in complicated nested structure)
- arguments:
- **object**: *object|array* object or array to set value in
- **path**: *string|assignmentsObject* path to the value you want to change, can be deep where field values are divided by *delimiter* (default: .) e.g. 'field.subField.somethingElse'. Can be an object e.g. { 'field.subField': 'newValue', 'anotherField.anotherSubField': 'anotherNewValue' } Lodash's array like syntax is also supported (e.g. 'field\[1\].subField')
- **path**: *string|assignmentsObject* path to the value you want to change, can be deep e.g. 'field.subField.somethingElse'. Can be an object e.g. { 'field.subField': 'newValue', 'anotherField.anotherSubField': 'anotherNewValue' } Lodash's array like syntax is also supported (e.g. 'field\[1\].subField')
- **value**: *any* value to be set in the path (if path is an object *value* is ignored)
- returns **newObject**

Expand Down

0 comments on commit 703b328

Please sign in to comment.