Skip to main content

function-catalog


title: Function & Operator Catalog sidebar_position: 4

Function and operator catalog

The catalog and the operator table are closed and enumerated — new capability is added as a named, typed entry, and this page is regenerated from that entry, never hand-edited. Every example shown below is executed as an assertion by the engine's own test suite (examples.test.ts), so a result shown here is a result the engine actually produces for that input.

Catalog version: 2.0.0 Catalog content hash: 7156229cd6155984cacd3c7303fd1e3fd08526767818d6fcf5c315ea9f3fd702 Hash scope: every .ts file under packages/engine/src/analysis, recursively, excluding *.test.ts files and catalog-hash.ts itself — the whole analysis tree, not only the catalog directory, because an operator implementation or a shared helper outside the catalog directory can also change what an expression evaluates to

The catalog is split across seven pages, one per group below — open one directly, or use the name index further down to jump straight to the entry you need.

GroupEntriesHolds
Aggregation5SUM, AVG, MIN, MAX, COUNT
Collections8GROUPBY, FIND_BY, GET, ARGS, SLICE, LENGTH, INCLUDES, JOIN
Number3ABS, ROUND, PARSENUMBER
Logic & Fallback2IF, COALESCE
String12UPPER, LOWER, TRIM, SUBSTRING, SPLIT, REPLACE, CONCAT, INDEXOF, LASTINDEXOF, PADSTART, PADEND, REPEAT
Date13NOW, TODAY, DATE, YEAR, MONTH, DAY, ADD_DAYS, ADD_MONTHS, DIFF_DAYS, START_OF_DAY, END_OF_DAY, PARSEDATE, FORMATDATE
Operators & Precedence25Every condition operator ENG-08 enumerates, plus the parser's operator precedence table

Find a name

Every function and operator name, alphabetically, linking to the page that documents it.

NamePage
ABSNumber
addOperators & Precedence
ADD_DAYSDate
ADD_MONTHSDate
andOperators & Precedence
approxEqualOperators & Precedence
ARGSCollections
AVGAggregation
COALESCELogic & Fallback
CONCATString
containsOperators & Precedence
COUNTAggregation
DATEDate
DAYDate
DIFF_DAYSDate
divOperators & Precedence
doesNotContainOperators & Precedence
END_OF_DAYDate
endsWithOperators & Precedence
equalOperators & Precedence
existsOperators & Precedence
FIND_BYCollections
FORMATDATEDate
GETCollections
greaterThanOperators & Precedence
greaterThanInclusiveOperators & Precedence
GROUPBYCollections
IFLogic & Fallback
inOperators & Precedence
INCLUDESCollections
INDEXOFString
isNullOperators & Precedence
JOINCollections
LASTINDEXOFString
LENGTHCollections
lessThanOperators & Precedence
lessThanInclusiveOperators & Precedence
LOWERString
matchesOperators & Precedence
MAXAggregation
MINAggregation
MONTHDate
mulOperators & Precedence
notOperators & Precedence
notEqualOperators & Precedence
notExistsOperators & Precedence
notInOperators & Precedence
NOWDate
orOperators & Precedence
PADENDString
PADSTARTString
PARSEDATEDate
PARSENUMBERNumber
regexMatchOperators & Precedence
REPEATString
REPLACEString
ROUNDNumber
SLICECollections
SPLITString
START_OF_DAYDate
startsWithOperators & Precedence
subOperators & Precedence
SUBSTRINGString
SUMAggregation
TODAYDate
TRIMString
UPPERString
YEARDate