frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Improve jsdoc of util.getObjectProperty to clarify thrown error

Browse Source 
See #2703
This commit is contained in:
Nick O'Leary 2020-09-28 14:23:23 +01:00
parent a1ab00c93e
commit 6e5f115bd5
No known key found for this signature in database
GPG Key ID: 4F2157149161A6C9
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/node_modules/@node-red/util/lib/util.js vendored
View File

@ -318,9 +318,23 @@ function getMessageProperty(msg,expr) {
/** /**
* Gets a property of an object. * Gets a property of an object.
* *
* Given the object:
*
* {
* "pet": {
* "type": "cat"
* }
* }
*
* - `pet.type` will return `"cat"`.
* - `pet.name` will return `undefined`
* - `car` will return `undefined`
* - `car.type` will throw an Error (as `car` does not exist)
*
* @param {Object} msg - the object * @param {Object} msg - the object
* @param {String} expr - the property expression * @param {String} expr - the property expression
* @return {any} the object property, or undefined if it does not exist * @return {any} the object property, or undefined if it does not exist
* @throws Will throw an error if the *parent* of the property does not exist
* @memberof @node-red/util_util * @memberof @node-red/util_util
*/ */
function getObjectProperty(msg,expr) { function getObjectProperty(msg,expr) {