This document describes a
Codeblock flow-node and provides information on
Codeblock flow-node configuration, metadata, and functionality.
|Codeblock||A flow-node that can be used for executing user code and returns the response. This flow-node allows custom business logic to be executed as part of the flow.|
Instance configuration (config)
|method||The name of the Codeblock to execute.||yes||string|
The typical usage of code blocks in a flow involves setting parameters, mapping responses, and setting required configs as noted in the example below.
Codeblock metadata should be included in the
/codeblocks directory of an API Builder Project. It is defined as a JSON file with the following properties:
The name of the Codeblock
The description of the Codeblock
The relative path to the function to be invoked.
The functional part of a Codeblock should be a
.js file which exports a function of the following signature:
invoke(arrow, params, cb);
arrow <Arrow>- The API Builder instance.
params <Object>- Key/value pairs of parameters passed to the flow-node instance.
cb <Function>- Callback.
err- Error. Passing this will cause the flow to cease processing and a 500 error to be returned from the endpoint which called it.
response- The data to be returned as the flow-node response.