diff --git a/src/builtins/camunda.json b/src/builtins/camunda.json index 26b0f3e..746d9fd 100644 --- a/src/builtins/camunda.json +++ b/src/builtins/camunda.json @@ -49,7 +49,7 @@ }, { "name": "number(from)", - "description": "

Parses the given string to a number.

\n

Function signature

\n
number(from: string): number\n
\n

Examples

\n
number("1500.5")\n// 1500.5\n
\n" + "description": "

Parses the given string to a number.

\n

Returns null if the string is not a number.

\n

Function signature

\n
number(from: string): number\n
\n

Examples

\n
number("1500.5")\n// 1500.5\n
\n" }, { "name": "context(entries)", @@ -57,11 +57,11 @@ }, { "name": "date(from)", - "description": "

Returns a date from the given value.

\n

Function signature

\n
date(from: string): date\n
\n

Parses the given string into a date.

\n
date(from: date and time): date\n
\n

Extracts the date component from the given date and time.

\n

Examples

\n
date("2018-04-29")\n// date("2018-04-29")\n\ndate(date and time("2012-12-25T11:00:00"))\n// date("2012-12-25")\n
\n" + "description": "

Returns a date from the given value.

\n

Returns null if the string is not a valid calendar date. For example, "2024-06-31" is invalid because June has\nonly 30 days.

\n

Function signature

\n
date(from: string): date\n
\n

Parses the given string into a date.

\n
date(from: date and time): date\n
\n

Extracts the date component from the given date and time.

\n

Examples

\n
date("2018-04-29")\n// date("2018-04-29")\n\ndate(date and time("2012-12-25T11:00:00"))\n// date("2012-12-25")\n
\n" }, { "name": "date(year, month, day)", - "description": "

Returns a date from the given components.

\n

Function signature

\n
date(year: number, month: number, day: number): date\n
\n

Examples

\n
date(2012, 12, 25)\n// date("2012-12-25")\n
\n" + "description": "

Returns a date from the given components.

\n

Returns null if the components don't represent a valid calendar date. For example, 2024,6,31 is invalid because\nJune has only 30 days.

\n

Function signature

\n
date(year: number, month: number, day: number): date\n
\n

Examples

\n
date(2012, 12, 25)\n// date("2012-12-25")\n
\n" }, { "name": "time(from)", @@ -77,7 +77,7 @@ }, { "name": "date and time(from)", - "description": "

Parses the given string into a date and time.

\n

Function signature

\n
date and time(from: string): date and time\n
\n

Examples

\n
date and time("2018-04-29T09:30:00")\n// date and time("2018-04-29T09:30:00")\n
\n" + "description": "

Parses the given string into a date and time.

\n

Returns null if the string is not a valid calendar date. For example, "2024-06-31T10:00:00" is invalid because\nJune has only 30 days.

\n

Function signature

\n
date and time(from: string): date and time\n
\n

Examples

\n
date and time("2018-04-29T09:30:00")\n// date and time("2018-04-29T09:30:00")\n
\n" }, { "name": "date and time(date, time)", @@ -207,6 +207,14 @@ "name": "string join(list, delimiter, prefix, suffix)", "description": "

Camunda Extension

\n

Joins a list of strings into a single string. This is similar to\nJava's joining\nfunction.

\n

If an item of the list is null, the item is ignored for the result string. If an item is\nneither a string nor null, the function returns null instead of a string.

\n

The resulting string starts with prefix, contains a delimiter between each element, and ends\nwith suffix.

\n

Function signature

\n
string join(list: list<string>, delimiter: string, prefix: string, suffix: string): string\n
\n

Examples

\n
string join(["a","b","c"], ", ", "[", "]")\n// "[a, b, c]"\n
\n" }, + { + "name": "is empty(list)", + "description": "

Camunda Extension

\n

Returns true if the given list is empty. Otherwise, returns false.

\n

Function signature

\n
is empty(list: list): boolean\n
\n

Examples

\n
is empty([])\n// true\n\nis empty([1,2,3])\n// false\n
\n" + }, + { + "name": "partition(list， size)", + "description": "

Camunda Extension

\n

Returns consecutive sublists of a list, each of the same size (the final list may be smaller).

\n

If size is less than 0, it returns null.

\n

Function signature

\n
partition(list: list, size: number): list\n
\n

Examples

\n
partition([1,2,3,4,5], 2)\n// [[1,2], [3,4], [5]]\n\npartition([], 2)\n// []\n\npartition([1,2], 0)\n// null\n
\n" + }, { "name": "decimal(n, scale)", "description": "

Rounds the given value at the given scale.

\n

Function signature

\n
decimal(n: number, scale: number): number\n
\n

Examples

\n
decimal(1/3, 2)\n// .33\n\ndecimal(1.5, 0)\n// 2\n
\n" @@ -385,11 +393,11 @@ }, { "name": "substring(string, start position)", - "description": "

Returns a substring of the given value starting at start position.

\n

Function signature

\n
substring(string: string, start position: number): string\n
\n

The start position starts at the index 1. The last position is -1.

\n

Examples

\n
substring("foobar", 3)\n// "obar"\n
\n" + "description": "

Returns a substring of the given value starting at start position.

\n

Function signature

\n
substring(string: string, start position: number): string\n
\n

The start position starts at the index 1. The last position is -1.

\n

Examples

\n
substring("foobar", 3)\n// "obar"\n\nsubstring("foobar", -2)\n// "ar"\n
\n" }, { "name": "substring(string, start position, length)", - "description": "

Returns a substring of the given value starting at start position.

\n

Function signature

\n
substring(string: string, start position: number, length: number): string\n
\n

The start position starts at the index 1. The last position is -1.

\n

Examples

\n
substring("foobar", 3, 3)\n// "oba"\n
\n" + "description": "

Returns a substring of the given value, starting at start position with the given length. If length is greater than\nthe remaining characters of the value, it returns all characters from start position until the end.

\n

Function signature

\n
substring(string: string, start position: number, length: number): string\n
\n

The start position starts at the index 1. The last position is -1.

\n

Examples

\n
substring("foobar", 3, 3)\n// "oba"\n\nsubstring("foobar", -3, 2)\n// "ba"\n\nsubstring("foobar", 3, 10)\n// "obar"\n
\n" }, { "name": "string length(string)", @@ -447,6 +455,22 @@ "name": "extract(string, pattern)", "description": "

Camunda Extension

\n

Returns all matches of the pattern in the given string. Returns an empty list if the pattern doesn't\nmatch.

\n

Function signature

\n
extract(string: string, pattern: string): list<string>\n
\n

The pattern is a string that contains a regular expression.

\n

Examples

\n
extract("references are 1234, 1256, 1378", "12[0-9]*")\n// ["1234","1256"]\n
\n" }, + { + "name": "trim(string)", + "description": "

Camunda Extension

\n

Returns the given string without leading and trailing spaces.

\n

Function signature

\n
trim(string: string): string\n
\n

Examples

\n
trim("  hello world  ")\n// "hello world"\n\ntrim("hello   world ")\n// "hello   world"\n
\n" + }, + { + "name": "uuid()", + "description": "

Camunda Extension

\n

Returns a UUID (Universally Unique Identifier) with 36 characters.

\n

Function signature

\n
uuid(): string\n
\n

Examples

\n
uuid()\n// "7793aab1-d761-4d38-916b-b7270e309894"\n
\n" + }, + { + "name": "to base64(value)", + "description": "

Camunda Extension

\n

Returns the given string encoded in Base64 format.

\n

Function signature

\n
to base64(value: string): string\n
\n

Examples

\n
to base64("FEEL")\n// "RkVFTA=="\n
\n" + }, + { + "name": "is blank(string)", + "description": "

Camunda Extension

\n

Returns true if the given string is blank (empty or contains only whitespaces).

\n

Function signature

\n
is blank(string: string): boolean\n
\n

Examples

\n
is blank("")\n// true\n\nis blank(" ")\n// true\n\nis blank("hello world")\n// false\n
\n" + }, { "name": "now()", "description": "

Returns the current date and time including the timezone.

\n

Function signature

\n
now(): date and time\n
\n

Examples

\n
now()\n// date and time("2020-07-31T14:27:30@Europe/Berlin")\n
\n" @@ -478,21 +502,5 @@ { "name": "last day of month(date)", "description": "

Camunda Extension

\n

Takes the month of the given date or date-time value and returns the last day of this month.

\n

Function signature

\n
last day of month(date: date): date\n
\n
last day of month(date: date and time): date\n
\n

Examples

\n
last day of month(date("2022-10-01"))\n// date("2022-10-31"))\n\nlast day of month(date and time("2022-10-16T12:00:00"))\n// date("2022-10-31"))\n
\n" - }, - { - "name": "is empty(list)", - "description": "

Camunda Extension

\n

Returns true if the given list is empty. Otherwise, returns false.

\n

Function signature

\n
is empty(list: list): boolean
\n

Examples

\n
is empty([])\n// true\n\nis empty([1,2,3])\n// false\n
" - }, - { - "name": "trim(string)", - "description": "

Camunda Extension

\n

Returns the given string without leading and trailing spaces.

\n

Function signature

\n
trim(string: string): string
\n

Examples

\n
trim(\"  hello world  \")\n// \"hello world\"\n\ntrim(\"hello   world \")\n// \"hello   world\"\n
" - }, - { - "name": "uuid()", - "description": "

Camunda Extension

\n

Returns a UUID (Universally Unique Identifier) with 36 characters.

\n

Function signature

\n
uuid(): string
\n

Examples

\n
uuid()\n// \"7793aab1-d761-4d38-916b-b7270e309894\"\n
" - }, - { - "name": "to base64(string)", - "description": "

Camunda Extension

\n

Returns the given string encoded in Base64 format.

\n

Function signature

\n
to base64(value: string): string
\n

Examples

\n
to base64(\"FEEL\")\n// \"RkVFTA==\"\n
" } ] \ No newline at end of file