Codeblocknode and provides information on
Codeblocknode configuration, metadata, and functionality.
A node that can be used for executing user code and returns the response. This node allows custom business logic to be execute as part of the flow.
Instance configuration (config)
The name of the Codeblock to execute.
The typical usage of codeblocks in flows 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 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 node response.