deep-props.get
Advanced tools
Comparing version 0.1.2 to 0.1.3
Changelog | ||
========= | ||
<a name="0.1.3"></a> | ||
## [0.1.3](https://github.com/jpcx/deep-props.get/tree/0.1.3) (2018-05-11) | ||
__Since: [deep-props 0.2.5](https://github.com/jpcx/deep-props/blob/master/CHANGELOG.md#0.2.5)__ | ||
| __[Changes since 0.1.2](https://github.com/jpcx/deep-props.get/compare/0.1.2...0.1.3)__ | [Release Notes](https://github.com/jpcx/deep-props.get/releases/tag/0.1.3) | [README](https://github.com/jpcx/deep-props.get/tree/0.1.3/README.md) | | ||
| --- | --- | --- | | ||
| [Source Code (zip)](https://github.com/jpcx/deep-props.get/archive/0.1.3.zip) | [Source Code (tar.gz)](https://github.com/jpcx/deep-props.get/archive/0.1.3.tar.gz) | | ||
| --- | --- | | ||
#### Bugfixes | ||
+ __docs:__ Updated JSDoc with new description. | ||
<a name="0.1.2"></a> | ||
@@ -5,0 +19,0 @@ ## [0.1.2](https://github.com/jpcx/deep-props.get/tree/0.1.2) (2018-05-11) |
@@ -283,3 +283,3 @@ /** | ||
/** | ||
* Retrieves a nested property from a data source by iterating over a supplied path. Supports Objects, Arrays, Maps, Weakmaps, and JSON strings automatically. Supports the use of a custom extraction function to handle unsupported datasets. | ||
* Retrieves a nested property from a data source by iterating over a supplied path. Supports Objects, Arrays, Maps, Sets, WeakMaps, and JSON strings automatically. Supports the use of a custom extraction function to handle unsupported datasets. | ||
* | ||
@@ -286,0 +286,0 @@ * @module get |
{ | ||
"name": "deep-props.get", | ||
"version": "0.1.2", | ||
"version": "0.1.3", | ||
"description": "Retrieves a nested property from a data source by iterating over a supplied path. Supports Objects, Arrays, Maps, Sets, WeakMaps, and JSON strings automatically. Supports the use of a custom extraction function to handle unsupported datasets.", | ||
@@ -5,0 +5,0 @@ "engines": { |
@@ -41,3 +41,3 @@ # [deep-props](https://github.com/jpcx/deep-props/blob/master/README.md).get | ||
***Note:*** For string paths using standard settings, '.' is considered the same as '[' and ']'. See [<code>Options</code>](https://github.com/jpcx/deep-props.get/blob/0.1.2/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.get/blob/0.1.3/docs/global.md#~Options) for instructions for customizing this behavior. | ||
@@ -180,3 +180,3 @@ **Nested Object Extraction** | ||
**Usage of a custom extraction function (see [<code>Options</code>](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md#~Options) and [<code>GetCustomizer</code>](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md#~GetCustomizer))** | ||
**Usage of a custom extraction function (see [<code>Options</code>](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md#~Options) and [<code>GetCustomizer</code>](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md#~GetCustomizer))** | ||
```js | ||
@@ -216,8 +216,8 @@ // Creation of a sample custom data structure which uses a 'retrieve' method for data access. | ||
### See: | ||
+ [API Docs](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/API.md) | ||
+ [Global Docs](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md) | ||
+ [API Docs](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/API.md) | ||
+ [Global Docs](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md) | ||
### Module: get | ||
Retrieves a nested property from a data source by iterating over a supplied path. Supports Objects, Arrays, Maps, Weakmaps, and JSON strings automatically. Supports the use of a custom extraction function to handle unsupported datasets. | ||
Retrieves a nested property from a data source by iterating over a supplied path. Supports Objects, Arrays, Maps, Sets, WeakMaps, and JSON strings automatically. Supports the use of a custom extraction function to handle unsupported datasets. | ||
@@ -228,9 +228,9 @@ ##### Parameters: | ||
| --- | --- | --- | --- | --- | | ||
| `host` | [deep-props.get~Host](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md#~Host) | | | Container to search within. | | ||
| `path` | [deep-props.get~Path](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md#~Path) | | | Path to desired property. | | ||
| `opt` | [deep-props.get~Options](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md#~Options) | \<optional> | {} | Execution settings. | | ||
| `host` | [deep-props.get~Host](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md#~Host) | | | Container to search within. | | ||
| `path` | [deep-props.get~Path](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md#~Path) | | | Path to desired property. | | ||
| `opt` | [deep-props.get~Options](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md#~Options) | \<optional> | {} | Execution settings. | | ||
Source: | ||
* [deep-props.get/index.js](https://github.com/jpcx/deep-props.get/blob/0.1.2/index.js), [line 282](https://github.com/jpcx/deep-props.get/blob/0.1.2/index.js#L282) | ||
* [deep-props.get/index.js](https://github.com/jpcx/deep-props.get/blob/0.1.3/index.js), [line 282](https://github.com/jpcx/deep-props.get/blob/0.1.3/index.js#L282) | ||
@@ -243,3 +243,3 @@ ##### Returns: | ||
[deep-props.get~Target](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md#~Target) | [deep-props.get~ResultGenerator](https://github.com/jpcx/deep-props.get/blob/0.1.2/docs/global.md#~ResultGenerator) | ||
[deep-props.get~Target](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md#~Target) | [deep-props.get~ResultGenerator](https://github.com/jpcx/deep-props.get/blob/0.1.3/docs/global.md#~ResultGenerator) | ||
@@ -250,3 +250,3 @@ # | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/deep-props.get/blob/0.1.2/CHANGELOG.md). | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/deep-props.get/blob/0.1.3/CHANGELOG.md). | ||
@@ -263,2 +263,2 @@ ## Contribution | ||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/deep-props.get/blob/0.1.2/LICENSE) file for details | ||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/deep-props.get/blob/0.1.3/LICENSE) file for details |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
56851