Suanpan_node_sdk NPM

简介

目前 Node Sdk

支持消息收发
读取组件的右面板参数
Event Log Sender
支持 oss 类型的 storage 功能 beta

Installation

npm install suanpan_node_sdk -S 
// or beta
npm install suanpan_node_sdk@beta -S

Docker

可以使用基础镜像 node_sdk_base:latest latest可替换为指定的SDK版本号例如：

ARG ARCH="amd64"
FROM registry.cn-shanghai.aliyuncs.com/shuzhi-$ARCH/node_sdk_base:latest

基础镜像中 suanpan_node_sdk 通过全局安装本地开发可以通过npm install -D suanpan_node_sdk来提供代码提示

功能列表

1. 获得右面板配置参数(parameter)

const sp = require('suanpan_node_sdk').sp
const spParameter = sp.parameter
console.log(spParameter)

2. 发送消息与接受消息

构建发送包

let msgPackOut = {
    out1: "a", //将发送 "a" 到第一个消息出口
    out2: "b", //将发送 "b" 到第二个消息出口
}

msgPackOut 对象的 key 由 out 与数字拼接而成的 key，表示第 N 个消息出口
msgPackOut 对象的 value 表示发送到对应出口的数据（value 必须是字符串）

监听 call 事件

每当有新消息到达组件，则会触发Call事件

sp.onCall((req, res) => {
    let msgPackIn = req.msg
    console.log(msgPackIn)
    // msgPackIn结构如下
    //{in1:"a"}
    // key(inN) 表示第N个消息入口, value是字符串
  
    // doSomething here
    res.send(msgPackOut) // 调用 res.send 发送数据包到下游节点
})

主动发送信息

sp.sendMessage(msgPackOut)

3. EventLogger Sender

提供 log 格式化的存储形式持久化在数据库中，app 释放后仍然保留，用于不同用户查看修改错误，用户重新部署后清除。logkit 能够直接运行在算盘 Server 中，也可以单独运行。架构图： Node Sdk 提供 event log（内部使用 socketio 作为接口的基础协议）接口单向传输到 logkit。

代码示例：

let { sp, EventLogger } = require('suanpan_node_sdk');

const eventLogger = EventLogger.Instance;

sp.onCall((req, res) => {

  if (!req.msg) {
    // 发送 event log
    eventLogger.warn('received message is empty.');
  }

  res.send({
    out1: 'hello world this send in call'
  });
});

默认情况下，用户代码（onCall）中运行时 Error，将会自动触发 event log 的 error 事件，将结构化错误信息发送到 logkit。等于在 after onCall 中插入如下代码：

eventLogger.error(e.message)

注：确保 sdk 版本在 1.4.2 以上

@infinitebrahmanuniverse/nolb-sua @everything-registry/sub-chunk-2843 ndoe_sdk_test

2 years ago

2 years ago

2 years ago

4 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

1.4.6-migrate-to-ts.11

5 years ago

1.4.6-migrate-to-ts.13

5 years ago

1.4.6-migrate-to-ts.12

5 years ago

1.5.2-beta-2

5 years ago

1.5.2-beta-1

5 years ago

1.5.2-beta-0

5 years ago

1.4.6-migrate-to-ts.10

5 years ago

1.4.6-migrate-to-ts.9

5 years ago

1.4.6-migrate-to-ts.6

5 years ago

1.4.6-migrate-to-ts.7

5 years ago

1.4.6-migrate-to-ts.8

5 years ago

1.4.6-migrate-to-ts.5

5 years ago

1.4.6-migrate-to-ts

5 years ago

1.4.6-migrate-to-ts.1

5 years ago

1.4.6-migrate-to-ts.2

5 years ago

1.4.6-migrate-to-ts.3

5 years ago

1.4.6-migrate-to-ts.4

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago