tmc.js v0.3.39

tmc.js

Event driven and chained Taobao Message Channel(TMC) for NodeJS

设计

核心包以事件作为驱动，通过注册TOPIC回调处理函数，实现了TMC产品服务的消息消费处理能力，同时通过Proxy代理，以TOPIC作为键值，平序注册消息消费处理函数，序图如下：

使用

npm i tmc.js

import Tmc from 'tmc.js';

new Tmc('your_app_key', 'your_app_secret')
.on('taobao_trade_TradeChanged', msg => console.info(msg))
.taobao_trade_TradeClose(msg => console.info(msg))
.connect();

API

new Tmc(appKey: string, appSecret: BinaryLike, groupName?: string | ConsumerOptions, options?: ConsumerOptions)

tmc.on(topic: string, listener: (this: Tmc, message: Message) => void) => Tmc

注册 topic 消息通知处理函数，默认已内置 消息 说明。 自v0.3.6起，默认开启消费端多维监听功能，topic字符串也可以是BU及BU_G单位，例如：

.on('taobao', console.info)
.on('alibaba_einvoice', console.info)

tmc[<topic>](fn: (this: Tmc, message: Message) => void) => Tmc

直接以 topic 为键值，注册消息通知处理函数。 自v0.3.6起，默认开启消费端多维监听功能，topic字符串也可以是BU及BU_G单位，例如：

.taobao(console.info)
.alibaba_einvoice(console.info)

tmc.reconnect(ms: number) => Tmc

当消费端 onerror/onclose 事件发生时，延迟 ms 毫秒自动重新建立连接。

tmc.connect(address?: string) => Tmc

消费端发起建立连接 onopen 事件，address 默认为 ws://mc.api.taobao.com/。

tmc.send(msg: Message, options?: { mask?: true, binary?: true }, cb?: (err: Error) => void) => void

自v0.3.4起，当自动应答确认消息无法满足需求的时候，比如消息处理失败，需要Publisher再次重推消息，在实例初始化时置options.autoReplyConfirmation=false，则在消息处理函数内，可以通过 this.send() 函数回复确认或者失败消息。例如：

new Tmc('your_app_key', 'your_app_secret', { autoReplyConfirmation: false })
.taobao_trade_TradeDelayConfirmPay(function needDoubleRetriesThenConfirm(msg) {
  if (msg instanceof Message && msg.content?.retried === 0) {
    this.send(
      new Message(MessageType.SENDACK, MessageKind.Failed)
      .with(MessageFields.ID, msg.content?.id)
      .with(MessageFields.MSG, 'Something went wrong, please retries this ID.')
    );
  }
})
.connect();

也可以使用此方法发送To淘宝消息。在>=v0.3.4 && <v0.3.7版本期间，需要自主对$.content.content数据做JSON字符串化(特别注意： 原生JSON对BigInt类型无法处理)。自v0.3.7起，可直接对$.content.content以原生object类型描述，SDK会将此对象转化成JSON字符串。例如：

/** @see https://open.taobao.com/tmc.htm?docId=732&docType=9 */
.send(
  new Message(MessageType.SEND, MessageKind.Data)
  .with(MessageFields.TOPIC, 'taobao_fuwu_ElectronicInvoice')
  .with(MessageFields.CONTENT, {
    id: 12345678901234567n, // 支持 BigInt 类型
    tid: 12345678901234567n,
    oid: 12345678901234567n,
    invoice_file: 12345678901234567n,
    e_invoice_no: '12342243435466',
    invoice_time: '2015-04-10 10:33:49', // 时区 +08:00
    invoice_no: '123456',
    invoice_code: '123456',
    amount: '100.00',
  })
  // >=v0.3.4 && <v0.3.7 写法
  // .with(MessageFields.CONTENT, '{"tid":12345678901234567,"amount":"100.00"}')
)

支持的TOPICS

链接

• 淘宝开放平台-消息服务使用介绍

变更历史

It used the github release page for the Changelog here.

License

MIT