JS on Dripline Documentation

Basics

Wed, 16 Sep 2020 22:38:02 +0200

JS

This filter allows to extend the basic driplane’s filter, defining Javascript scripts. It is based on islazy/plugin which in turn is based on robertkrimen/otto.
Defining a JS file with our custom logic, it is possible create a complex filter.

Parameters

Parameter	Type	Default	Description
path	STRING	empty	path of the Javascript file (it can contains multiple functions)
function	STRING	empty	name of the function in the JS file to call when a `Message` is received

... | js(path="script.js", function="MyFunction") | ...

Output

The output Message of this filter depends on the return value of the JS function itself.

Entrypoint

Wed, 16 Sep 2020 22:38:02 +0200

Entrypoint

The JS file consists of one or more functions, and they can be used in different filters or in combination between them.
The function must respect some constraints:

the function’s name contained in the function parameter of the filter has to start with a capital letter;
the function prototype must 3 variables;
the function must return a JS object with at least the filtered field;

Function’s prototype

The function’s name specified in the function parameter of the filter, receives 3 input parameters:

Plugin Packages

Wed, 16 Sep 2020 22:38:02 +0200

Packages

Since the JS doesn’t have all the useful functions to perform operations like on file manipulation or http request (see otto docs for more info), driplane maps and export to the JS environment some Go functions as packages.

These mapped functions are not definitive and they could change over time.

File

This package contains functions for manipulating files.

Return

The return value will be a JS object containing 2 fields: