rudder-json-template-engine

The Customer Data Platform for Developers

Website · Documentation · Community Slack

---

rudder-json-template-engine

A library to process JSON data using a custom syntax based on javascript and jspath. We thank the jspath authors for their excellent work, as our library is an extension of the original library. We also want to thank IBM team for their work on jsonata, as we have taken several ideas from the library. You can also consider our library as an alternative to jsonata.

Overview

This library generates a javascript function code from the template and then uses the function to evaluate the JSON data. It outputs the javascript code in the following stages:

1. Lexing (Tokenization)
2. Parsing (AST Creation)
3. Translation (Code generation)

Engine class abstracts the above steps and provides a convenient way to use the json templates to evaluate the inputs.

Features

1. Variables
2. Arrays
3. Objects
4. Functions
5. Bindings
6. Comments
7. Paths
   • Filters
   • Selectors
   • Context variables
   • Simple paths
   • Rich paths
   • Paths options
8. Conditions
   • Comparisons
9. Math operations
10. Logical operations
11. Compile time expressions

For more examples, refer Scenarios

Syntax

Getting started

npm install rudder-json-template-engine

const engine = new JsonTemplateEngine(`'Hello ' + .name`);
engine.evaluate({name: 'World'});

Testing

npm test

Contribute

We would love to see you contribute to RudderStack. Get more information on how to contribute here.

License

The RudderStack rudder-json-template-engine is released under the MIT License.

Changelog

0.3.0 (2022-12-07)

Miscellaneous

• release 0.3.0 (e7b2fef)