@cf-platform/mq
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

@cf-platform/mq

一、初始化

1. 初始化参数 MqOptions

取值为*号的参数为必填参数

参数名 描述 类型 取值
url 地址 string *
restartInterval 重启间隔 number 3000
loginParams 登录参数 LoginParams *
customEvents 自定义事件 CustomEvents null

2. 登录参数 MqLoginParams

取值为*号的字段为必填字段

名称 描述 类型 取值
uid 用户ID string *
channel 通道 string web
appVersion 系统ID string *
osVersion 设备版本号 string browser.version
packageName 包名 string com.farsunset.cim
language 语言 string window.navigator.language
deviceId 设备唯一ID string *
deviceName 设备名称 string browser.name
custom 自定义参数 string

3. 自定义事件 MqEvents

方法名 描述 类型 是否必须
onSocketOpen socket连接成功时触发方法 Function
onSocketConnect socket连接时触发方法 Function(url: string)
onSocketClose socket连接关闭时触发方法 Function
onSocketError socket连接错误时触发方法 Function
onSendPong 发送心跳时触发方法 Function
onMessage 收到消息时触发方法 Function(message: any)
onReply 收到回复时触发方法 Function(reply: any)
onLoginSuccess 回复登录成功时触发方法 Function(reply: any)
onLoginDisconnected 回复登录断开时触发方法 Function(reply: any)
onAuthenticationFailed 回复鉴权失败时触发方法 Function(reply: any)

4. 初始化方法

new Mq(<CIMOptions>{
    url: 'wss://127.0.0.1:8080',
    restartInterval: 0,
    loginParams: {
      uid: 'xxxxxxx',
      appVersion: 'xx',
      deviceId: 'xxxxxxxx'
    }
});

二、发送消息

1. 发送参数 MqMessage

参数名 描述 类型 可选值
key 消息标识 string client_closedsend_messagebroadcast_message
custom 自定义参数 any

2. 发送方法

Mq.sendMessage(data: CIMMessage);

Mq

declare class Mq {
    /**
     * @param options Mq参数
     */
    constructor(options: MqOptions);
    
    /** 连接 */
    connect(): void;
    
    /** 重新连接 */
    reconnect(): void;
    
    /** 关闭 */
    close(): void;
    
    /**
     * 发送消息
     * @param MqMessage
     */
    sendMessage(data: CIMMessage): void;
}

Readme

Keywords

Package Sidebar

Install

npm i @cf-platform/mq

Weekly Downloads

5

Version

1.0.4

License

ISC

Unpacked Size

6.8 kB

Total Files

5

Last publish

Collaborators

  • object_fu