跳转到内容

🔐开发文档

如果你有意向为项目贡献或自行修改本地,请认真阅读此文档

全局模块

在阅读以下文档前,你首先要了解全局模块#miao#miao.models#miao.path来自于哪里,以及它们的作用

无论是在Miao-Yunzai还是TRSS-Yunzai,都在项目根目录的package.json文件中全局声明了#miao#miao.models,这就意味着你可以在除项目中包含package.json文件的全部plugins包括example的js中使用#miao#miao.models导入它们

#miao.path仅在Miao-Plugin中声明了此模块,故仅可在Miao-Plugin内部使用

#miao

导入模块示例代码

JavaScript
import { Data, Cfg, Format, Common, Version, App, MiaoError, Meta } from "#miao"
模块提供文件名说明
DataData.js提供包括检查与创建目录、JSON文件读写、redis请求获取等多种常用函数
MetaMeta.js存储及查询插件所有的缓存数据
FormatFormat.js提供对传入元素类型转化、数字字符串处理的函数
CommonCommon.js提供设置读取、图像渲染、等待函数
CfgCfg.js提供用于配置文件读取写入的函数
VersionVersion.js输出Yunzai-Bot及自身版本信息
AppApp.js插件功能v3转换器
MiaoErrorMiaoError.js输出错误消息

概览