🔐开发文档
如果你有意向为项目贡献或自行修改本地,请认真阅读此文档
全局模块
在阅读以下文档前,你首先要了解全局模块#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"
模块 | 提供文件名 | 说明 |
---|---|---|
Data | Data.js | 提供包括检查与创建目录、JSON文件读写、redis请求获取等多种常用函数 |
Meta | Meta.js | 存储及查询插件所有的缓存数据 |
Format | Format.js | 提供对传入元素类型转化、数字字符串处理的函数 |
Common | Common.js | 提供设置读取、图像渲染、等待函数 |
Cfg | Cfg.js | 提供用于配置文件读取写入的函数 |
Version | Version.js | 输出Yunzai-Bot及自身版本信息 |
App | App.js | 插件功能v3转换器 |
MiaoError | MiaoError.js | 输出错误消息 |