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

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

Documentation

Module README files:

• extract

API Usage Documentation files:

• extract

Module-Specific Type Definitions and Functions:

• extract

Global Namespace Type Definitions:

• deep-props

Versioning

Versioned using SemVer. For available versions, see the tags on this repository.

Contribution

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

Author

• Justin Collier - jpcx

License

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

Changelog

0.1.0 (2018-05-04)

| Changes since 0.0.8 | Release Notes | README | | --- | --- | --- |

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

Breaking Changes

• API: Module functionality moved to deep-props.extract. See the readme for more information.

Features

• API: Added deep-props.extract submodule.
• extract: Submodule created.

<a name="0.0.8"></a>