deep-props.set - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

CHANGELOG.md

 Changelog
 =========
 
+<a name="0.1.2"></a>
+## [0.1.2](https://github.com/jpcx/deep-props.set/tree/0.1.2) (2018-05-26)
+
+__Since: [deep-props 0.3.2](https://github.com/jpcx/deep-props/blob/master/CHANGELOG.md#0.3.2)__
+
+| __[Changes since 0.1.1](https://github.com/jpcx/deep-props.set/compare/0.1.1...0.1.2)__ | [Release Notes](https://github.com/jpcx/deep-props.set/releases/tag/0.1.2) | [README](https://github.com/jpcx/deep-props.set/tree/0.1.2/README.md) |
+| --- | --- | --- |
+
+| [Source Code (zip)](https://github.com/jpcx/deep-props.set/archive/0.1.2.zip) | [Source Code (tar.gz)](https://github.com/jpcx/deep-props.set/archive/0.1.2.tar.gz) |
+| --- | --- |
+
+#### Features
+  + __docs:__ Clarified structure creation documentation.
+
 <a name="0.1.1"></a>
@@ -5,0 +19,0 @@ ## [0.1.1](https://github.com/jpcx/deep-props.set/tree/0.1.1) (2018-05-26)

package.json

 {
   "name": "deep-props.set",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Sets values within nested objects; creates structure if not found. Supports setting within Objects, Arrays, Maps, Sets, WeakMaps, and WeakSets; supports creation of Objects, Arrays, and Maps.",
@@ -5,0 +5,0 @@ "engines": {

README.md

@@ -7,2 +7,13 @@ # [deep-props](https://github.com/jpcx/deep-props/blob/master/README.md).set
 
+Uses the [deep-props.get](https://github.com/jpcx/deep-props.get/blob/0.1.6/README.md) module for dataset exploration. As such, allows for setting within all types supported by the deep-props.get module (with the exception of strings).
+
+In terms of new structure creation, keys are analyzed in the following manner in order to determine what kind of structure to construct:
+  + Number keys (or string numbers) construct arrays.
+  + String keys construct Objects.
+  + Object keys construct Maps.
+
+The next key along the path is used during this structure determination.
+
+Behavior can be customized by using either the ```forceConstructor``` or the ```setCustomizer``` settings in the [module options](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/global.md#~Options).
+
 See the [usage examples](#usage) for an overview of different types of data structures.
@@ -42,3 +53,3 @@
 
-***Note:*** For string paths using standard settings, '.' is considered the same as '[' and ']'. See [<code>Options</code>](https://github.com/jpcx/deep-props.set/blob/0.1.1/docs/global.md#~Options) for instructions for customizing this behavior.
+***Note:*** For string paths using standard settings, '.' is considered the same as '[' and ']'. See [<code>Options</code>](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/global.md#~Options) for instructions for customizing this behavior.
 
@@ -127,4 +138,4 @@ **Setting within existing Object structure**
 ### See:
-  + [API Docs](https://github.com/jpcx/deep-props.set/blob/0.1.1/docs/API.md)
-  + [Global Docs](https://github.com/jpcx/deep-props.set/blob/0.1.1/docs/global.md)
+  + [API Docs](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/API.md)
+  + [Global Docs](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/global.md)
 
@@ -139,10 +150,10 @@ ### Module: set
 | --- | --- | --- | --- | --- |
-| `host` | [deep-props.set~Host](https://github.com/jpcx/deep-props.set/blob/0.1.1/docs/global.md#~Host) |  |  | Container to search within. |
-| `path` | [deep-props.set~Path](https://github.com/jpcx/deep-props.set/blob/0.1.1/docs/global.md#~Path) |  |  | Path to desired property. |
+| `host` | [deep-props.set~Host](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/global.md#~Host) |  |  | Container to search within. |
+| `path` | [deep-props.set~Path](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/global.md#~Path) |  |  | Path to desired property. |
 | `data` | * |  |  | Data to set at endpoint of path. |
-| `opt` | [deep-props.set~Options](https://github.com/jpcx/deep-props.set/blob/0.1.1/docs/global.md#~Options) | \<optional> | {} | Execution settings. |
+| `opt` | [deep-props.set~Options](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/global.md#~Options) | \<optional> | {} | Execution settings. |
 
 Source:
 
-*   [deep-props.set/index.js](https://github.com/jpcx/deep-props.set/blob/0.1.1/index.js), [line 365](https://github.com/jpcx/deep-props.set/blob/0.1.1/index.js#L365)
+*   [deep-props.set/index.js](https://github.com/jpcx/deep-props.set/blob/0.1.2/index.js), [line 365](https://github.com/jpcx/deep-props.set/blob/0.1.2/index.js#L365)
 
@@ -155,3 +166,3 @@ ##### Returns:
 
-boolean | [deep-props.set~ResultGenerator](https://github.com/jpcx/deep-props.set/blob/0.1.1/docs/global.md#~ResultGenerator)
+boolean | [deep-props.set~ResultGenerator](https://github.com/jpcx/deep-props.set/blob/0.1.2/docs/global.md#~ResultGenerator)
 
@@ -162,3 +173,3 @@ #
 
-Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/deep-props.set/blob/0.1.1/CHANGELOG.md).
+Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/deep-props.set/blob/0.1.2/CHANGELOG.md).
 
@@ -175,2 +186,2 @@ ## Contribution
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/deep-props.set/blob/0.1.1/LICENSE) file for details
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/deep-props.set/blob/0.1.2/LICENSE) file for details

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

46878

increased by3.28%

Number of lines in readme file

181

increased by6.47%

No dependency changes