Node-RED:Библиотеки/node-red/Function

Содержание

Введение

Руководство пользователя

Рецепты

Создание нод

Библиотеки

Перевод: Максим Кузьмин

Проверка/Оформление/Редактирование: Мякишев Е.А.

Нода «Function»

Здесь можно задать JavaScript-функцию, которая будет применена к сообщениям, получаемым нодой.

Входящие сообщения передаются JavaScript-объекту «msg».

Согласно договоренности между разработчиками, в этом объекте должно быть свойство «msg.payload», содержащее тело этого сообщения.

В итоге эта JavaScript-функция, выполнив свои операции, должна вернуть один или несколько объектов «msg», но она может совсем ничего не вернуть, чтобы остановить работу потока.

Подробное описание

Более подробно о написании JavaScript-функций читайте в этой статье.

Отправка сообщений

Нода «Function» отправляет свои сообщения дальше по потоку либо при помощи возврата сообщения/сообщений, либо при помощи функции node.send(messages).

Нода «Function» может вернуть/отправить:

• Один объект «msg» – он будет отправлен нодам, подключенным к первому выходному порту
• Массив объектов «msg» – они будут отправлены нодам, подключенным к соответствующим выходным портам

Если какой-либо элемент массива сам является массивом сообщений, на соответствующий выходной порт будет отправлено несколько сообщений.

Если нода «Function» вернет «null» – либо сама, либо в качестве элемента массива – никакого сообщения отправлено не будет.

Логирование и обработка ошибок

Чтобы записать что-нибудь в логи или сообщить об ошибке, можно воспользоваться функциями ниже:

• node.log("Сообщение для логов")
• node.warn("Предупреждение")
• node.error("Ошибка")

Для обработки ошибок можно воспользоваться нодой «Catch». Чтобы «пробудить» ноду «Catch», в функцию node.error() нужно добавить второй параметр – объект «msg»:

node.error("Ошибка",msg);

Доступ к информации о ноде

В функции ноды «Function» можно использовать данные об ID и названии ноды – при помощи вот этих свойств:

• «node.id» – ID ноды
• «node.name» – название ноды

Использование переменных окружения

Доступ к переменным окружения можно получить при помощи функции env.get("МОЯ_ПЕРЕМЕННАЯ_ОКРУЖЕНИЯ").