deep-props

deep-props

Migration notice: users of deep-props <= v0.0.8 must replace module calls with deep-props.extract. See the deployment instructions below or install the deep-props.extract standalone package. All other functionality is the same.

Provides a collection of tools for performing operations on deeply nested object properties, prototypes, and object keys. Avoids stack limit violations by using task queues rather than recursion. Allows for custom execution settings including non-native dataset handling.

Submodules:

• extract

  

  • 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.

• 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.

Getting Started

Prerequisites

Node.JS version 8.7.0 or above.

Installing

Installing all modules:

npm install deep-props

Submodules may be installed individually. See the module list above.

Testing

The following command will test the package for errors. It prints a large selection of examples to the console; scroll through its output if you want to learn more about the utility.

npm test --prefix /path/to/node_modules/deep-props

Deployment

const props = require('deep-props')
const extract = props.extract
const get = props.get

Documentation

Please see the associated README files for general usage information.

API docs contain module parameters and return information. Links to type definitions are provided as well in order to explain in detail the types of expected inputs and outputs.

Global docs contain all type definitions and functions used internally.

README Files:

• extract
• get

API Docs:

• deep-props
• extract
• get

Changelogs:

• deep-props
• extract
• get

Type Definitions and Global Functions:

• deep-props
• extract
• get

Versioning

Versioned using SemVer. For available versions, see the Changelog.

Contribution

Please raise an issue if you find any. Pull requests are welcome!

Author

• Justin Collier - jpcx

License

This project is licensed under the MIT License - see the LICENSE file for details

Changelog

0.2.0 (2018-05-09)

| Changes since 0.1.0 | Release Notes | README | | --- | --- | --- |

| Source Code (zip) | Source Code (tar.gz) | | --- | --- |

Bumps

• extract: 0.1.0 -> 0.1.1

Bugfixes

• docs: Replaced (U+2264) symbol with '<=' (853bc99)

Features

• repo: Moved submodules to dedicated repositories. Using submodule approach.
• API: Added deep-props.get submodule.
• docs: Added changelog.
• docs: Improved documentation generation scripts.
• extract/docs: Improved documentation.
• get: Submodule created.

<a name="0.1.0"></a>