README.md

Pipe Functions

What Is A Pipe Function?

A pipe function is a function that is chained in the format expression. Pipe functions are executed sequentially.

Flow Diagram

The flow diagram of expression${path:func1(param1)|func2(param2)} is illustrated on the following figure.

stateDiagram-v2
    [*] --> Path  :source
    Path --> Pipes:path
    Pipes --> [*] :out2 
    state Pipes {
        direction LR
        [*]                --> func1(path,param1):path
        func1(path,param1) --> func2(out1,param2):out1
        func2(out1,param2) --> [*]               :out2
    }

For the expression above, the execution order;

• evaluates the path
• executes func1() with the evaluated value
• executes func2() with the result of the func1()
• returns the output of func2()

Naming Convention

A transformation's name must be a valid javascript function name. For clarity, the camel case naming convention is suggested.

Parameters

A transformation function only accepts valid JSON values.

• number
• string
• boolean
• null
• JSON object
• array