| Arithmetic Operators | Description | Example |
|---|
| (+, -, *, /) |
| Similar to the JavaScript arithmetic operators except that increment (++) and decrement (--) are not supported. | Note |
|---|
All arithmetic operators return a floating point number. If an integer is desired, then the global function {{parseInt}} should be used to cast the arithmetic expression as an integer. |
|
| 1/2 = .5
parseInt(1/2) = 0 |
In this section
| Child pages (Children Display) |
|---|
Logical Operators
Logical operators (&&, ||, !) behave the same as JavaScript logical operators.
String Operators
String operators (+) behave the same as JavaScript string operators except that the shorthand assignment operator (+=) is not supported.
Spread Operators
The spread operator |
| Spread Operator |
| (...) | This operator makes it easier to build arrays, objects, and call functions where the list of arguments is built at runtime. For instance, while using in an array literal, the value on the right of the operator is inserted into the new array at that position. Similarly, in a function call, the array expands and is used as the arguments to the function. In an object literal, the right side of the operator is another object that has its keys added to the new object. |
Examples:
To build a new array that is made up of another array surrounded by two elements: | Code Block |
|---|
["header", ...$body, "footer"] |
|
To find the maximum value in an array of numbers: | Code Block |
|---|
Math.max(...$numbers) |
To create a new object with some fixed values and entries in the "$extra" object: | Code Block |
|---|
{ first_name: $fname, last_name: $lname, ... $extra } |
|
| Special Operators |
| Info |
|---|
iconfalse | The conditional operator (?) | This operator allows you to specify a value to use based on the result of an expression. |
| Code Block |
|---|
condition ? trueValue : falseValue |
The condition expression
The condition expression will be evaluated and |
trueValue will the trueValue will be the result of the expression if the condition evaluates to true, |
falseValue will else the falseValue will be the result. |
condition ? trueValue : falseValue
| $text
|
| Code Block |
|---|
Example:
| Info |
|---|
icon | false |
| instanceof | The instanceof operator returns True if the given object is an instance of the given type. |
type
| $my_array instanceof Array |
The possible values for the type are: Null, Boolean, String, Number, Object, Array, Date, LocalDate, DateTime, and LocalDateTime. |
Example:
| Info |
|---|
iconfalse | $my_array instanceof Array
|
| Info |
|---|
|
The match | This operator allows you to conditionally evaluate one of a number of expressions based on whether an input value matches a given pattern. |
Example:
code
info |
The typeof operator This operator returns the type of a value as a string. |
typeof operand
The possible return values are: "boolean", "number", "string", "object", and "array". Syntax:
typeof operand | typeof $name (Where $name="SnapLogic") returns "String" |
| in |
in This operator returns true if the property name or array index is in the given object or array. |
| Info |
|---|
|
Syntax: name|index in operand
|
:
Comments
You can add notes to your expressions using comments. A comment starts with '/*' and ends with '*/', for example:
| Info |
|---|
|
/* say hello */ "Hello, World!"
|
The comment
will be is ignored when evaluating the
expression, it expression—it is only for the reader's benefit.
| Operator Type | Individual Operators |
|---|
| member | . [] |
| call | () |
| negation | ! - |
| multiply/divide | * / % |
| addition/subtraction | + - |
| relational | < <= > >= |
| equality | == != |
| logical-and | && |
| logical-or | || |
| comma | , |
- Assignment
- Creating variables and assigning values is not supported
- Example: var temp = 10
- Short hand assignment
- Strict equals
- Strict not equals
- Increment
- Decrement
To access values in a document,
you can use JavaScript object accessors
can be used.
For a given document data:
| Info |
|---|
|
{ first_name: "James",
last_name: "Smith"
} The expression $first_name would return the 'first_name' property which is James. |
The You can also access the 'first_name' property |
can also be accessed by using array notation $['first_name'].
JavaScript array accessors can be used also if the object is an array/list.
For a given document data: [ 1, 2, 3]
|
$[1] would return the value 2. |
More complex example
Complex Example:
| Info |
|---|
|
{
names: ["Joe", "Bob", "Fred"]
} $names[2] would return the value Fred. |
Custom You can create custom expression language functions can be created using the arrow function syntax:
| Code Block |
|---|
// A function that takes multiple parameters:
(param1, param2, ..., paramN) => expression
// A function that takes a single parameter does not need parentheses:
(param) => expression
param => expression
// A function with no parameters requires parentheses:
() => expression
// Function parameters can also have default values
(param1 = defaultValue1, param2 = defaultValue2, ..., paramN = defaultValueN) => expression |
These functions can be passed to other functions that accept callbacks, like Array.map() or Array.filter(), or they can be put into an expression library for use in any expression property in your pipelinesPipelines.
Example
To multiply all numbers in an array by ten:
[1, 2, 3].map(x => x * 10)
Result:
[10, 20, 30]
