hellow.js

/**
 *
 * a sample 'hellow <x>' node. you can use this as a template for actual nodes of
 * your package, just remember to remove it or at least not include it in your
 * 'index.js' platform package config.
 *
 */

const platform = require('connect-platform');


/**
 *
 * lets define a new node for the platform.
 *
 */
platform.core.node({
  /**
   *
   * it should be accessible via '/test-package/hellow'
   *
   */
  path: '/test-package/hellow',

  /**
   *
   * it should not be publicly accessible by default. note that if you
   * switch this to 'true', this node will also be accessible via web requests
   * for people who install your package.
   *
   */
  public: false,

  /**
   *
   * this is not necessary for non-public nodes. for the public nodes, this will
   * be the http method through which the node is publicly accessible, so either
   * 'GET', 'POST', 'PUT' or 'DELETE' (yeah we do not support other http methods).
   *
   */
  method: 'GET',

  /**
   *
   * the list of inputs for this node, in our case merely
   * a name we want to say 'hellow' to.
   *
   */
  inputs: ['name'],

  /**
   *
   * the possible list of outputs for your node. these are
   * different keys that can get different values, in case of
   * different scenarios that might happen. in this case,
   * we have only one scenario in which a 'message' containing
   * our 'hellow' message will be the output.
   *
   */
  outputs: ['message'],

  /**
   *
   * these can be control outputs, i.e. outputs without any accompanying
   * data. if your node should not return any data, make sure to use
   * control outputs instead of outputs. these can also be used for exceptional
   * cases like errors or misconfigurations.
   *
   */
  controlOutputs: [],

  /**
   *
   * these act as the documentation of your node. make sure to write explicit
   * and helpful documentation on what does this node do and what each input/output/controlOutput
   * is.
   *
   * you can use html tags in these descriptions. classes 'hl', 'hl-blue' and 'hl-green'
   * can be used to highlight stuff.
   */
  hints: {
    /**
     *
     * this is the description of the node in general.
     *
     */
    node: 'says hellow to <span class="hl-blue">name</span>.',

    /**
     *
     * these are the descriptions of each input value.
     *
     */
    inputs: {
      name: 'the one to whom the hellow shall be said',
    },

    /**
     *
     * these are the descriptions of possible output values.
     *
     */
    outputs: {
      message: 'the hellow message to the given <span class="hl-blue">name</span>.'
    },

    /**
     *
     * these are the descriptions of possible control outputs.
     *
     */
    controlOutputs: {}
  }
},
  /**
   *
   * this function is the main logic of your node.
   * - 'inputs' is a dictionary of all given inputs.
   * - 'output' is a function you can use to output some data.
   *    it can be used like `output('x', data)` where 'x' is defined in
   *    possible output keys (see above).
   * - 'control' is a function you can use to end with a control output.
   *    it can be used like `control('x')` where 'x' is defined in
   *    possible control outputs (see above).
   *
   */
  (inputs, output, control) => {
    output('message', `hellow ${inputs.name}`);
  }
);