mm_ret v1.4.0

mm_ret

这是一个用于输出JSON-RPC 2.0标准结果的Node.js模块。它提供了一系列便捷的方法来生成标准的JSON-RPC响应和请求。

安装

npm install mm_ret

基本使用

const { Ret, Req, Error } = require('mm_ret');
// 或者直接使用全局变量
require('mm_ret');

类说明

Error 类

错误代码管理类，用于管理JSON-RPC标准错误码和自定义错误码。

方法

get(keyword)

• 说明：根据关键词或错误码获取对应的错误信息
• 参数：
  • keyword: {String|Number} 关键词或错误码
• 返回值：{Object} 错误信息对象，包含code和message

Ret 类

响应结果生成类，用于生成标准的JSON-RPC 2.0响应结果。

方法

body(result, error, id)

• 说明：生成基础的JSON-RPC响应体
• 参数：
  • result: {Object} 返回的结果
  • error: {Object} 返回的错误信息
  • id: {String} 消息ID
• 返回值：{Object} 标准的JSON-RPC响应对象

error(code, message, id)

• 说明：生成错误响应
• 参数：
  • code: {Number} 错误码
  • message: {String} 错误信息
  • id: {String} 消息ID
• 返回值：{Object} 包含错误信息的JSON-RPC响应对象

list(list, count, id)

• 说明：生成列表类型的响应
• 参数：
  • list: {Array} 数据列表
  • count: {Number} 总数量
  • id: {String} 消息ID
• 返回值：{Object} 包含列表数据的JSON-RPC响应对象

obj(obj, id)

• 说明：生成对象类型的响应
• 参数：
  • obj: {Object} 返回的对象
  • id: {String} 消息ID
• 返回值：{Object} 包含对象数据的JSON-RPC响应对象

bl(bl, tip, id)

• 说明：生成布尔类型的响应
• 参数：
  • bl: {Boolean} 布尔值
  • tip: {String} 提示信息
  • id: {String} 消息ID
• 返回值：{Object} 包含布尔值和提示信息的JSON-RPC响应对象

Req 类

请求生成类，用于生成标准的JSON-RPC 2.0请求。

构造函数

new Req(scope)

• scope: {String} 作用域，默认为"sys"

方法

send(method, params)

• 说明：生成JSON-RPC请求
• 参数：
  • method: {String} 方法名
  • params: {Object} 参数对象
• 返回值：{Object} 标准的JSON-RPC请求对象

使用示例

响应结果示例

// 错误响应
var body = $.ret.error(10000, '错误');
// 输出: {"error":{"code":10000,"message":"错误"}}

// 普通结果响应
body = $.ret.body("这是一个结果");
// 输出: {"result":"这是一个结果"}

// 对象响应
body = $.ret.obj({ "name": "张三", age: 18});
// 输出: {"result":{"obj":{"name":"张三","age":18}}}

// 列表响应
body = $.ret.list([{ "name": "张三", age: 18}, { "name": "李四", age: 24}]);
// 输出: {"result":{"list":[{"name":"张三","age":18},{"name":"李四","age":24}]}}

// 布尔响应
body = $.ret.bl(true, "修改成功");
// 输出: {"result":{"bl":true,"tip":"修改成功"}}

请求示例

// 基本请求
var body = $.req.send('test', "你好吗");

// 使用模板的请求
$.req.tpl.message = {
    "to_user": "",
    "from_user": "",
    "content": ""
};
body = $.req.send('message', { content: "你好吗?", "media": { "title": "牛" } });
// 输出的请求会自动合并模板中的字段

错误码说明