Scribd Logo
Upload

Welcome to Scribd!

  • 17 views

    Writing Functions

    Uploaded by

    rshegde
    The Function node allows JavaScript code to run against messages passed through it. The message is passed in as an object called msg, which by convention contains the message payload as the msg.payload property. Other nodes may attach additional properties to the message. The code in the Function node represents the function body, and the function must return a msg object or null; returning anything else will cause an error. The function can construct a completely new msg object before returning it.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd

    Writing Functions

    Uploaded by

    rshegde
    17 views1 page
    The Function node allows JavaScript code to run against messages passed through it. The message is passed in as an object called msg, which by convention contains the message payload as the msg.payload property. Other nodes may attach additional properties to the message. The code in the Function node represents the function body, and the function must return a msg object or null; returning anything else will cause an error. The function can construct a completely new msg object before returning it.

    Original Title

    1

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    The Function node allows JavaScript code to run against messages passed through it. The message is passed in as an object called msg, which by convention contains the message payload as the msg.payload property. Other nodes may attach additional properties to the message. The code in the Function node represents the function body, and the function must return a msg object or null; returning anything else will cause an error. The function can construct a completely new msg object before returning it.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    17 views1 page

    Writing Functions

    Uploaded by

    rshegde
    The Function node allows JavaScript code to run against messages passed through it. The message is passed in as an object called msg, which by convention contains the message payload as the msg.payload property. Other nodes may attach additional properties to the message. The code in the Function node represents the function body, and the function must return a msg object or null; returning anything else will cause an error. The function can construct a completely new msg object before returning it.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    of 1

    Writing Functions

    The Function node allows JavaScript code to be run against the messages that are
    passed through it.

    The message is passed in as an object called msg. By convention it will have


    a msg.payload property containing the body of the message.

    Other nodes may attach their own properties to the message, and they should be
    described in their documentation.

    Writing a Function
    The code entered into the Function node represents the body of the function. The
    most simple function simply returns the message exactly as-is:

    return msg;

    If the function returns null, then no message is passed on and the flow ends.

    The function must always return a msg object. Returning a number or string will
    result in an error.

    The returned message object does not need to be same object as was passed in;
    the function can construct a completely new object before returning it. For example:

    var newMsg = { payload: msg.payload.length };


    return newMsg;
    Note : constructing a new message object will lose any message properties of the received message.
    This will break some flows, for example the HTTP In/Response flow requires
    the msg.req and msg.res properties to be preserved end-to-end. In general, function
    nodes should return the message object they were passed having made any changes to its
    properties.

    Use node.warn() to show warnings in the sidebar to help you debug. For example:

    node.warn("my var xyz = " + xyz);

    See logging section below for more details.

    You might also like