From 2cc8cbcff356892c10fda6e0c637845de75293c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Pluszczewski?= Date: Tue, 23 Jan 2018 13:53:18 +0100 Subject: [PATCH] Update API.md --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 94b96c9..900fe35 100644 --- a/docs/API.md +++ b/docs/API.md @@ -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**