mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
Merge pull request #2323 from boisei0/jsdoc-red-util
Fixed docstrings to have them match the function signature
This commit is contained in:
commit
a1d186112a
@ -301,7 +301,7 @@ function normalisePropertyExpression(str) {
|
||||
* front of the property expression if present.
|
||||
*
|
||||
* @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
|
||||
* @memberof @node-red/util_util
|
||||
*/
|
||||
@ -316,7 +316,7 @@ function getMessageProperty(msg,expr) {
|
||||
* Gets a property of an 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
|
||||
* @memberof @node-red/util_util
|
||||
*/
|
||||
@ -468,7 +468,7 @@ function evaluateEnvProperty(value, node) {
|
||||
*
|
||||
* 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
|
||||
* @memberof @node-red/util_util
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user