Skip to end of metadata
Go to start of metadata
This document describes a Codeblock node and provides information on Codeblock node configuration, metadata, and functionality.

Name

Description

Codeblock

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)

Property

Description

Required

Type

method

The name of the Codeblock to execute.

yes

string

The typical usage of codeblocks in flows involves setting parameters, mapping responses, and setting required configs as noted in the example below.

Configuration example

Metadata

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:

Property

Description

Required

Type

name

The name of the Codeblock

yes

string

description

The description of the Codeblock

yes

string

path

The relative path to the function to be invoked.

yes

string

Metadata example

 

Functionality

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.

Icon

Most of the time errors should be returned in the callback as a standard response. Using the first parameter to return errors is the same as throwing an error in the Codeblock and should rarely need to be used.

Functionality example