deep-props
Advanced tools
Comparing version 0.0.7 to 0.0.8
@@ -15,3 +15,3 @@ # Module | ||
###Examples | ||
### Examples | ||
@@ -18,0 +18,0 @@ **Simple nested object** |
@@ -193,3 +193,3 @@ # Index | ||
## genProtoProp(target, permissions, opt) ⇒ [<code>Array.<Prop></code>](#Prop) | ||
Generates a prop for a target object's prototype. | ||
Generates a prop for a Target object's prototype. Will attach Target object's permission statuses using the same 'parentIs' language, even though it is not technically a child. | ||
@@ -875,3 +875,3 @@ **Returns**: [<code>Array.<Prop></code>](#Prop) - Array with single entry of '\_\_proto__' key and value. | ||
| --- | --- | --- | | ||
| [host] | [<code>Host</code>](#Host) | When a non-primitive key has been encountered, a separate chain will be created with that key. Items on that chain will be labeled with a 'host' property to specify which host the path applies to. PropAt Objects lacking a 'host' property imply that the path applies to the initially supplied Host. | | ||
| [host] | [<code>Host</code>](#Host) | When a non-primitive key has been encountered, a separate chain will be created with that key. Items on that chain will be labeled with a 'host' property to specify which Host the path applies to. PropAt Objects lacking a 'host' property imply that the path applies to the initially supplied Host. | | ||
| path | [<code>Path</code>](#Path) | Describes the steps taken from the Host in order to reach the Prop's value. | | ||
@@ -919,3 +919,3 @@ | [value] | <code>\*</code> | Value described at the Prop's location (if any). In cases of a previously discovered reference (circular or otherwise), value will be replaced with a ref property (unless opt.showRefValues is true). | | ||
| [gen] | <code>boolean</code> | | Whether or not to return a generator instead of executing the entire search. | | ||
| [full] | <code>boolean</code> | | If true, replaces undefined Options with maximum search settings (All options except for propsCustomizer will be set to true). User supplied options supercede any changes here. | | ||
| [full] | <code>boolean</code> | | If true, replaces undefined options with maximum search settings (all options except for propsCustomizer will be set to true). User supplied options supercede any changes here. | | ||
| [propsCustomizer] | [<code>PropsCustomizer</code>](#PropsCustomizer) | | Function used for custom extraction of PropEntries from a Target. | | ||
@@ -922,0 +922,0 @@ |
{ | ||
"name": "deep-props", | ||
"version": "0.0.7", | ||
"version": "0.0.8", | ||
"description": "Creates an array of deep paths and properties associated with an object. Non-recursively iterates through deep objects until an endpoint is reached. Optionally unpacks prototypes and non-enumerable property descriptors. Supports Objects, Arrays, Maps, and Sets automatically.", | ||
@@ -5,0 +5,0 @@ "engines": { |
@@ -183,3 +183,3 @@ # deep-props | ||
| [gen] | <code>boolean</code> | | Whether or not to return a generator instead of executing the entire search. | | ||
| [full] | <code>boolean</code> | | If true, replaces undefined Options with maximum search settings (All options except for propsCustomizer will be set to true). User supplied options supercede any changes here. | | ||
| [full] | <code>boolean</code> | | If true, replaces undefined options with maximum search settings (all options except for propsCustomizer will be set to true). User supplied options supercede any changes here. | | ||
| [propsCustomizer] | [<code>PropsCustomizer</code>](https://github.com/jpcx/deep-props/blob/master/docs/global.md#PropsCustomizer) | | Function used for custom extraction of PropEntries from a Target. | | ||
@@ -198,3 +198,3 @@ | ||
| --- | --- | --- | | ||
| [host] | [<code>Host</code>](https://github.com/jpcx/deep-props/blob/master/docs/global.md#Host) | When a non-primitive key has been encountered, a separate chain will be created with that key. Items on that chain will be labeled with a 'host' property to specify which host the path applies to. PropAt Objects lacking a 'host' property imply that the path applies to the initially supplied Host. | | ||
| [host] | [<code>Host</code>](https://github.com/jpcx/deep-props/blob/master/docs/global.md#Host) | When a non-primitive key has been encountered, a separate chain will be created with that key. Items on that chain will be labeled with a 'host' property to specify which Host the path applies to. PropAt Objects lacking a 'host' property imply that the path applies to the initially supplied Host. | | ||
| path | [<code>Path</code>](https://github.com/jpcx/deep-props/blob/master/docs/global.md#Path) | Describes the steps taken from the Host in order to reach the Prop's value. | | ||
@@ -201,0 +201,0 @@ | [value] | <code>\*</code> | Value described at the Prop's location (if any). In cases of a previously discovered reference (circular or otherwise), value will be replaced with a ref property (unless opt.showRefValues is true). | |
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
105120