@node-red/runtime.hooks

运行时钩子引擎

可使用以下钩子

消息发送

  • onSend - 传入一个 SendEvent 对象数组。这些对象中的消息正是节点传递给 node.send 的内容 - 这意味着可能存在对同一消息对象的重复引用。
  • preRoute - 传入一个 SendEvent
  • preDeliver - 传入一个 SendEvent。本地路由器已识别出要发送到的节点。此时,如果需要,消息已被克隆。
  • postDeliver - 传入一个 SendEvent。消息已分派以异步传递(除非设置了同步传递标志,在这种情况下它将继续作为同步传递)
  • onReceive - 当节点即将接收消息时,传入一个 ReceiveEvent
  • postReceive - 当消息已传递给节点的 input 处理程序时,传入一个 ReceiveEvent
  • onComplete - 当节点已完成消息或记录错误时,传入一个 CompleteEvent

add(hookId, callback)

为命名钩子注册处理程序

参数
名称 类型 描述
hookId 字符串

要附加到的钩子的名称

回调 function

钩子的回调函数

remove(hookId)

从命名钩子中移除处理程序

参数
名称 类型 描述
hookId 字符串

要移除的钩子事件的名称 - 必须是 name.label