mirror of https://github.com/node-red/node-red.git
275 lines
28 KiB
JSON
275 lines
28 KiB
JSON
{
|
||
"$string": {
|
||
"args": "arg[, prettify]",
|
||
"desc": "Преобразует параметр `arg` в строку, используя следующие правила приведения:\n\n - Строки возвращаются как есть\n - Функции преобразуются в пустую строку\n - Числовая бесконечность и NaN выдают ошибку, поскольку они не могут быть представлены числом в JSON\n - Все остальные значения преобразуются в строку JSON с помощью функции `JSON.stringify`. Если значение `prettify` равно true, тогда будет сгенерирован \"отформатированный\" JSON. То есть каждое поле будет в отдельной строке, а строки будут иметь отступ в зависимости от глубины поля."
|
||
},
|
||
"$length": {
|
||
"args": "str",
|
||
"desc": "Возвращает количество символов в строке `str`. Выдается ошибка, если `str` не является строкой."
|
||
},
|
||
"$substring": {
|
||
"args": "str, start[, length]",
|
||
"desc": "Возвращает строку, содержащую символы из первого параметра `str`, начиная с позиции `start` (отсчет с нуля). Если указан `length`, то подстрока будет содержать максимум `length` символов. Если `start` отрицателен, то это означает количество символов с конца `str`."
|
||
},
|
||
"$substringBefore": {
|
||
"args": "str, chars",
|
||
"desc": "Возвращает подстроку перед первым вхождением последовательности символов `chars` в строке `str`. Если `str` не содержит `chars`, то он возвращает `str`."
|
||
},
|
||
"$substringAfter": {
|
||
"args": "str, chars",
|
||
"desc": "Возвращает подстроку после первого вхождения последовательности символов `chars` в строке `str`. Если `str` не содержит `chars`, то он возвращает `str`."
|
||
},
|
||
"$uppercase": {
|
||
"args": "str",
|
||
"desc": "Возвращает строку со всеми символами `str`, преобразованными в верхний регистр."
|
||
},
|
||
"$lowercase": {
|
||
"args": "str",
|
||
"desc": "Возвращает строку со всеми символами `str`, преобразованными в нижний регистр."
|
||
},
|
||
"$trim": {
|
||
"args": "str",
|
||
"desc": "Нормализует и обрезает все пробельные символы в строке `str`, выполняя следующие шаги:\n\n - Все символы табуляции, возврата каретки и перевода строки заменяются пробелами.\n- Последовательности пробелов сокращаются до одного пробела.\n- Пробелы в начале и конце `str` удаляются.\n\n Если `str` не указан (то есть эта функция вызывается без аргументов), тогда значение контекста используется в качестве значения `str`. Выдается ошибка, если `str` не является строкой."
|
||
},
|
||
"$contains": {
|
||
"args": "str, pattern",
|
||
"desc": "Возвращает `true`, если строка `str` соответствует шаблону `pattern`, в противном случае возвращает `false`. Если `str` не указан (то есть эта функция вызывается с одним аргументом), то значение контекста используется как значение `str`. Параметр `pattern` может быть либо строкой, либо регулярным выражением."
|
||
},
|
||
"$split": {
|
||
"args": "str[, separator][, limit]",
|
||
"desc": "Разбивает строку `str` на массив подстрок. Выдает ошибку, если `str` не является строкой. Необязательный параметр `separator` (строка или регулярное выражение) указывает символы внутри строки `str`, относительно которых она должна быть разделена. Если `separator` не указан, то предполагается пустая строка, и `str` будет разбит на массив из отдельных символов. Выдает ошибку, если `separator` не является строкой. Необязательный параметр `limit` - это число, указывающее максимальное количество подстрок для включения в результирующий массив. Любые дополнительные подстроки отбрасываются. Если `limit` не указан, то весь `str` разделяется без ограничения размера результирующего массива. Выдает ошибку, если `limit` не является положительным числом."
|
||
},
|
||
"$join": {
|
||
"args": "array[, separator]",
|
||
"desc": "Объединяет массив подстрок в одну объединенную строку, в которой каждая подстрока отделена необязательным параметром `separator`. Выдает ошибку, если входной массив содержит элемент, который не является строкой. Если `separator` не указан, то предполагается, что это пустая строка, то есть нет `separator` между подстроками. Выдает ошибку, если `separator` не является строкой."
|
||
},
|
||
"$match": {
|
||
"args": "str, pattern [, limit]",
|
||
"desc": "Применяет строку `str` к регулярному выражению `pattern` и возвращает массив объектов, каждый из которых содержит информацию о каждом совпадении внутри `str`."
|
||
},
|
||
"$replace": {
|
||
"args": "str, pattern, replacement [, limit]",
|
||
"desc": "Находит вхождения шаблона `pattern` в строке `str` и заменяет их на строку `replacement`.\n\nНеобязательный параметр `limit` - это максимальное количество замен."
|
||
},
|
||
"$now": {
|
||
"args":"",
|
||
"desc":"Создает отметку времени в формате, совместимом с ISO 8601, и возвращает ее как строку."
|
||
},
|
||
"$base64encode": {
|
||
"args":"string",
|
||
"desc":"Преобразует ASCII-строку в base-64 кодировку. Каждый символ в строке обрабатывается как байт двоичных данных. Для этого необходимо, чтобы все символы в строке находились в диапазоне от 0x00 до 0xFF, который включает все символы строк в URI-кодировке. Символы Юникода за пределами этого диапазона не поддерживаются."
|
||
},
|
||
"$base64decode": {
|
||
"args":"string",
|
||
"desc":"Преобразует байты в кодировке base-64 в строку, используя кодовую страницу Юникод UTF-8."
|
||
},
|
||
"$number": {
|
||
"args": "arg",
|
||
"desc": "Преобразует параметр `arg` в число с использованием следующих правил приведения:\n\n - Числа возвращаются как есть\n - Строки, которые содержат последовательность символов, представляющих допустимое в JSON число, преобразуются в это число\n - Все остальные значения вызывают ошибку."
|
||
},
|
||
"$abs": {
|
||
"args":"number",
|
||
"desc":"Возвращает абсолютное значение числа `number`."
|
||
},
|
||
"$floor": {
|
||
"args":"number",
|
||
"desc":"Возвращает значение числа `number`, округленное до ближайшего целого числа, которое меньше или равно `number`."
|
||
},
|
||
"$ceil": {
|
||
"args":"number",
|
||
"desc":"Возвращает значение числа `number`, округленное до ближайшего целого числа, которое больше или равно `number`."
|
||
},
|
||
"$round": {
|
||
"args":"number [, precision]",
|
||
"desc":"Возвращает значение числа `number`, округленное до количества десятичных знаков, указанных необязательным параметром `precision`."
|
||
},
|
||
"$power": {
|
||
"args":"base, exponent",
|
||
"desc":"Возвращает значение числа `base`, возведенное в степень `exponent`."
|
||
},
|
||
"$sqrt": {
|
||
"args":"number",
|
||
"desc":"Возвращает квадратный корень из значения числа `number`."
|
||
},
|
||
"$random": {
|
||
"args":"",
|
||
"desc":"Возвращает псевдослучайное число, которе больше или равно нулю и меньше единицы."
|
||
},
|
||
"$millis": {
|
||
"args":"",
|
||
"desc":"Возвращает число миллисекунд с начала Unix-эпохи (1 января 1970 года по Гринвичу) в виде числа. Все вызовы `$millis()` в пределах выполнения выражения будут возвращать одно и то же значение."
|
||
},
|
||
"$sum": {
|
||
"args": "array",
|
||
"desc": "Возвращает арифметическую сумму массива чисел `array`. Вызывает ошибку, если входной массив `array` содержит элемент, который не является числом."
|
||
},
|
||
"$max": {
|
||
"args": "array",
|
||
"desc": "Возвращает максимальное число в массиве чисел `array`. Вызывает ошибку, если входной массив `array` содержит элемент, который не является числом."
|
||
},
|
||
"$min": {
|
||
"args": "array",
|
||
"desc": "Возвращает минимальное число в массиве чисел `array`. Вызывает ошибку, если входной массив `array` содержит элемент, который не является числом."
|
||
},
|
||
"$average": {
|
||
"args": "array",
|
||
"desc": "Возвращает среднее значение массива чисел `array`. Вызывает ошибку, если входной массив `array` содержит элемент, который не является числом."
|
||
},
|
||
"$boolean": {
|
||
"args": "arg",
|
||
"desc": "Приводит аргумент к логическому значению, используя следующие правила: \n\n - Логические значения возвращаются как есть\n - пустая строка: `false`\n - непустая строка: `true`\n - число равное `0`: `false`\n - ненулевое число: `true`\n - `null` : `false`\n - пустой массив: `false`\n - массив, который содержит хотя бы один элемент, приводимый к `true`: `true`\n - массив, все элементы которого приводятся к `false`: `false`\n - пустой объект: `false`\n - непустой объект: `true`\n - функция: `false`"
|
||
},
|
||
"$not": {
|
||
"args": "arg",
|
||
"desc": "Возвращает логическое НЕ для аргумента. `arg` сначала приводится к логическому значению"
|
||
},
|
||
"$exists": {
|
||
"args": "arg",
|
||
"desc": "Возвращает логическое `true`, если выполнение выражения `arg` возвращает значение, или `false`, если выражение ничему не соответствует (например, путь к несуществующему полю)."
|
||
},
|
||
"$count": {
|
||
"args": "array",
|
||
"desc": "Возвращает количество элементов в массиве"
|
||
},
|
||
"$append": {
|
||
"args": "array, array",
|
||
"desc": "Присоединяет один массив к другому"
|
||
},
|
||
"$sort": {
|
||
"args":"array [, function]",
|
||
"desc":"Возвращает массив, содержащий все значения параметра `array`, но отсортированные по порядку.\n\nЕсли указан компаратор `function`, то это должна быть функция, которая принимает два параметра:\n\n`function(val1, val2)`\n\nЭту функцию вызывает алгоритм сортировки для сравнения двух значений: val1 и val2. Если значение val1 следует поместить после значения val2 в желаемом порядке сортировки, то функция должна возвращать логическое значение `true`, чтобы обозначить замену. В противном случае она должна вернуть `false`."
|
||
},
|
||
"$reverse": {
|
||
"args":"array",
|
||
"desc":"Возвращает массив, содержащий все значения из параметра `array`, но в обратном порядке."
|
||
},
|
||
"$shuffle": {
|
||
"args":"array",
|
||
"desc":"Возвращает массив, содержащий все значения из параметра `array`, но перемешанный в случайном порядке."
|
||
},
|
||
"$zip": {
|
||
"args":"array, ...",
|
||
"desc":"Возвращает свернутый (сжатый) массив, содержащий сгруппированные массивы значений из аргументов `array1` … `arrayN` по индексам 0, 1, 2...."
|
||
},
|
||
"$keys": {
|
||
"args": "object",
|
||
"desc": "Возвращает массив, содержащий ключи объекта. Если аргумент является массивом объектов, то возвращаемый массив содержит недублированный список всех ключей из всех объектов."
|
||
},
|
||
"$lookup": {
|
||
"args": "object, key",
|
||
"desc": "Возвращает значение, связанное с ключом в объекте. Если первый аргумент является массивом объектов, то просходит поиск по всем объектам в массиве, и возвращаются значения, связанные со всеми вхождениями ключа."
|
||
},
|
||
"$spread": {
|
||
"args": "object",
|
||
"desc": "Разбивает объект, содержащий пары ключ / значение, на массив объектов, каждый из которых имеет одну пару ключ / значение из входного объекта. Если параметр является массивом объектов, то результирующий массив содержит объект для каждой пары ключ / значение из каждого объекта предоставленного массива."
|
||
},
|
||
"$merge": {
|
||
"args": "array<object>",
|
||
"desc": "Объединяет массив объектов в один объект, содержащий все пары ключ / значение каждого из объектов входного массива. Если какой-либо из входных объектов содержит один и тот же ключ, возвращаемый объект будет содержать значение последнего в массиве. Вызывает ошибку, если входной массив содержит элемент, который не является объектом."
|
||
},
|
||
"$sift": {
|
||
"args":"object, function",
|
||
"desc":"Возвращает объект, который содержит только пары ключ / значение из параметра `object`, которые удовлетворяют предикату `function`, переданному в качестве второго параметра.\n\n`function`, которая передается в качестве второго параметра, должна иметь следующую сигнатуру:\n\n`function(value [, key [, object]])`"
|
||
},
|
||
"$each": {
|
||
"args":"object, function",
|
||
"desc":"Возвращает массив, который содержит значения, возвращаемые функцией `function` при применении к каждой паре ключ/значение из объекта `object`."
|
||
},
|
||
"$map": {
|
||
"args":"array, function",
|
||
"desc":"Возвращает массив, содержащий результаты применения функции `function` к каждому значению массива `array`.\n\nФункция `function`, указанная в качестве второго параметра, должна иметь следующую сигнатуру:\n\n`function(value [, index [, array]])`"
|
||
},
|
||
"$filter": {
|
||
"args":"array, function",
|
||
"desc":"Возвращает массив, содержащий только те значения из массива `array`, которые удовлетворяют предикату `function`.\n\nФункция `function`, указанная в качестве второго параметра, должна иметь следующую сигнатуру:\n\n`function(value [, index [, array]])`"
|
||
},
|
||
"$reduce": {
|
||
"args":"array, function [, init]",
|
||
"desc":"Возвращает агрегированное значение, полученное в результате последовательного применения функции `function` к каждому значению в массиве в сочетании с результатом от предыдущего применения функции.\n\nФункция должна принимать два аргумента и вести себя как инфиксный оператор между каждым значением в массиве `array`. Сигнатура `function` должна иметь форму: `myfunc($accumulator, $value[, $index[, $array]])`\n\nНеобязательный параметр `init` используется в качестве начального значения в агрегации."
|
||
},
|
||
"$flowContext": {
|
||
"args": "string[, string]",
|
||
"desc": "Извлекает свойство контекста потока.\n\nЭто функция от Node-RED."
|
||
},
|
||
"$globalContext": {
|
||
"args": "string[, string]",
|
||
"desc": "Извлекает свойство глобального контекста.\n\nЭто функция от Node-RED."
|
||
},
|
||
"$pad": {
|
||
"args": "string, width [, char]",
|
||
"desc": "Возвращает копию строки `string` с дополнительным заполнением, если необходимо, чтобы общее количество символов как минимум соответствовало абсолютному значению параметра `width`.\n\nЕсли `width` является положительным числом, то строка дополняется справа; если отрицательным, то дополняется слева.\n\nНеобязательный аргумент `char` указывает символ(ы) для заполнения. Если не указано, по умолчанию используется пробел."
|
||
},
|
||
"$fromMillis": {
|
||
"args": "number",
|
||
"desc": "Преобразует число, представляющее миллисекунды с начала Unix-эпохи (1 января 1970 года по Гринвичу), в строку отметки времени в формате ISO 8601."
|
||
},
|
||
"$formatNumber": {
|
||
"args": "number, picture [, options]",
|
||
"desc": "Преобразует число `number` в строку и форматирует ее в десятичное представление, как указано в строке `picture`.\n\nПоведение этой функции соответствует XPath/XQuery-функции fn:format-number, как определено в спецификация XPath F&O 3.1. Строка `picture` определяет, как форматируется число и имеет тот же синтаксис, что и fn:format-number.\n\nНеобязательный третий аргумент `options` используется для переопределения символов форматирования, специфичных для локали по умолчанию, таких как десятичный разделитель. Если аргумент указан, то это должен быть объект, содержащий пары имя/значение, указанные в разделе десятичного формата спецификации XPath F&O 3.1."
|
||
},
|
||
"$formatBase": {
|
||
"args": "number [, radix]",
|
||
"desc": "Преобразует число `number` в строку и форматирует ее в целое число, представленное в системе счисления, указанной аргументом `radix`. Если `radix` не указан, то по умолчанию используется десятичная. Значение 'radix` может быть от 2 до 36, в противном случае выдается ошибка."
|
||
},
|
||
"$toMillis": {
|
||
"args": "timestamp",
|
||
"desc": "Преобразует строку `timestamp` в формате ISO 8601 в число миллисекунд с начала Unix-эпохи (1 января 1970 года по Гринвичу). Вызывает ошибку, если строка в неправильном формате."
|
||
},
|
||
"$env": {
|
||
"args": "arg",
|
||
"desc": "Возвращает значение переменной среды.\n\nЭто функция от Node-RED."
|
||
},
|
||
"$eval": {
|
||
"args": "expr [, context]",
|
||
"desc": "Анализирует и исполняет строку `expr`, которая содержит JSON или выражение JSONata, используя текущий контекст в качестве контекста для исполнения."
|
||
},
|
||
"$formatInteger": {
|
||
"args": "number, picture",
|
||
"desc": "Преобразует число `number` в строку и форматирует ее в целочисленное представление, как указано в строке `picture`. Строка `picture` определяет, как форматируется число и имеет тот же синтаксис, что и `fn:format-integer` из спецификации XPath F&O 3.1."
|
||
},
|
||
"$parseInteger": {
|
||
"args": "string, picture",
|
||
"desc": "Разбирает содержимое строки `string` в целое число (как число JSON), используя формат, указанный в строке `picture`. Строковый параметр `picture` имеет тот же формат, что и `$formatInteger`."
|
||
},
|
||
"$error": {
|
||
"args": "[str]",
|
||
"desc": "Вызывает ошибку с сообщением. Необязательная строка `str` заменяет сообщение по умолчанию $error() function evaluated`"
|
||
},
|
||
"$assert": {
|
||
"args": "arg, str",
|
||
"desc": "Если значение `arg` равно true, функция возвращает значение undefined. Если значение `arg` равно false, генерируется исключение с `str` в качестве сообщения об исключении."
|
||
},
|
||
"$single": {
|
||
"args": "array, function",
|
||
"desc": "Возвращает одно-единственное значение из массива `array`, которое удовлетворяет предикату `function` (то есть когда `function` возвращает логическое `true` при передаче значения). Выдает исключение, если число подходящих значений не одно.\n\nФункция должна соответствовать следующей сигнатуре: `function(value [, index [, array]])` где value - элемент массива, index - позиция этого значения, а весь массив передается в качестве третьего аргумента"
|
||
},
|
||
"$encodeUrlComponent": {
|
||
"args": "str",
|
||
"desc": "Кодирует компонент Uniform Resource Locator (URL), заменяя каждый экземпляр определенных символов одной, двумя, тремя или четырьмя escape-последовательностями, представляющими кодировку UTF-8 символа.\n\nПример: `$encodeUrlComponent(\"?x=test\")` => `\"%3Fx%3Dtest\"`"
|
||
},
|
||
"$encodeUrl": {
|
||
"args": "str",
|
||
"desc": "Кодирует Uniform Resource Locator (URL), заменяя каждый экземпляр определенных символов одной, двумя, тремя или четырьмя escape-последовательностями, представляющими кодировку UTF-8 символа.\n\nПример: `$encodeUrl(\"https://mozilla.org/?x=шеллы\")` => `\"https://mozilla.org/?x=%D1%88%D0%B5%D0%BB%D0%BB%D1%8B\"`"
|
||
},
|
||
"$decodeUrlComponent": {
|
||
"args": "str",
|
||
"desc": "Декодирует компонент Uniform Resource Locator (URL), ранее созданный с помощью encodeUrlComponent.\n\nПример: `$decodeUrlComponent(\"%3Fx%3Dtest\")` => `\"?x=test\"`"
|
||
},
|
||
"$decodeUrl": {
|
||
"args": "str",
|
||
"desc": "Декодирует компонент Uniform Resource Locator (URL), ранее созданный с помощью encodeUrl. \n\nПример: `$decodeUrl(\"https://mozilla.org/?x=%D1%88%D0%B5%D0%BB%D0%BB%D1%8B\")` => `\"https://mozilla.org/?x=шеллы\"`"
|
||
},
|
||
"$distinct": {
|
||
"args": "array",
|
||
"desc": "Возвращает массив содержащий все элементы из массива `array`, с удаленными дупликатами"
|
||
},
|
||
"$type": {
|
||
"args": "value",
|
||
"desc": "Возвращает тип значения `value` в виде строки. Если `value` не определено, то будет возвращено `undefined`"
|
||
},
|
||
"$moment": {
|
||
"args": "[str]",
|
||
"desc": "Получает date объект, используя библиотеку Moment."
|
||
}
|
||
}
|