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

Merge pull request #2323 from boisei0/jsdoc-red-util

Browse Source 
Fixed docstrings to have them match the function signature
This commit is contained in:
Nick O'Leary 2019-10-10 14:26:52 +01:00 committed by GitHub
commit a1d186112a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -301,7 +301,7 @@ function normalisePropertyExpression(str) {
* front of the property expression if present. * front of the property expression if present.
* *
* @param {Object} msg - the message object * @param {Object} msg - the message object
* @param {String} str - the property expression * @param {String} expr - the property expression
* @return {any} the message property, or undefined if it does not exist * @return {any} the message property, or undefined if it does not exist
* @memberof @node-red/util_util * @memberof @node-red/util_util
*/ */
@ -316,7 +316,7 @@ function getMessageProperty(msg,expr) {
* Gets a property of an object. * Gets a property of an object.
* *
* @param {Object} msg - the object * @param {Object} msg - the object
* @param {String} str - 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
* @memberof @node-red/util_util * @memberof @node-red/util_util
*/ */
@ -468,7 +468,7 @@ function evaluateEnvProperty(value, node) {
* *
* For example, `#:(file)::foo` results in ` { store: "file", key: "foo" }`. * For example, `#:(file)::foo` results in ` { store: "file", key: "foo" }`.
* *
* @param {String} value - the context property string to parse * @param {String} key - the context property string to parse
* @return {Object} The parsed property * @return {Object} The parsed property
* @memberof @node-red/util_util * @memberof @node-red/util_util
*/ */