AutoJs6 声明文件 (d.ts)
TypeScript Declarations for AutoJs6
实现或增强开发工具的代码智能补全功能:
点击展开或收起样例展示
可以从 NPM 或 GitHub 获取主目录.
npm i @sm003/autojs6-dts安装后, 定位到 /node_modules/@sm003/autojs6-dts/declarations.
下载最新项目 zip 数据包, 解压后得到 declarations 文件夹.
如使用 WebStorm, 此步骤可略过.
将主目录放置到项目的任意目录中.
假设用户有一个名为 hello 的项目, 项目目录结构如下:
hello / images / ...
hello / docs / ...
hello / main.js
hello / project.json
... ...
则 declarations 主目录支持以下方式放置:
hello / declarations / (推荐)
hello / images / declarations /
hello / docs / declarations /
hello / ... / ... / declarations /
但不能放置在项目的同级或上级目录中.
开发工具会自动识别并开始索引所有声明文件.
索引完成后开始编写代码并体验代码智能提示.
注: 部分编辑器可能需要重新启动才能开始声明文件的索引.
VSCode 可能无法像 WebStorm 一样识别任意位置的 declarations 文件夹, 尤其是使用 npm 命令部署后, declarations 文件夹更是难以被 VSCode 默认识别. 因此需要将 jsconfig.json 文件复制到项目根目录中, 如:
hello / mode_modules / @sm003 / autojs6-dts / ...
hello / jsconfig.json
hello / main.js
... ...
如果项目中本身已存在 jsconfig.json 文件, 只需将下列配置合并到已有文件即可:
{
"compilerOptions": {
"typeRoots": [
"./node_modules/@sm003/autojs6-dts/declarations",
"./declarations"
]
}
}重启 VSCode 后, 示例中的 hello/main.js 可实现或增强代码智能补全.
从 NPM 直接获取更新:
npm update @sm003/autojs6-dts如需检查更新, 除直接到 当前项目主页 查看外, 还可定位到项目根目录的 package.json 文件, 鼠标悬停在 @sm003/autojs6-dts 依赖项的版本值处, 在浮动窗口中可查看是否存在版本更新. 另外 VSCode 也可借助 Version Lens 插件实现版本更新检查.
通常情况下, AutoJs6 发布版本更新后, 声明文件项目也会伴随更新.
新增全局对象epub/$epub声明 (AutoJs6 6.8.0, 由 Readium EPUB Reader 插件提供):open/openAsync, 便捷层metadata/toc/readingOrder/text/cover/search及其Async形态, 阅读器read/readAsync,isAvailable/isAvailableAsync与EpubError新增Internal.Epub命名空间:Book(元数据, 目录, 阅读顺序, 位置数, 正文提取text/textAll, 封面与资源导出, 全文搜索及关闭),ReaderSession事件发射器 (open/progress/bookmark/error/close事件, 跳转, 翻页, 偏好, 书签与关闭),Locator,Metadata/TocEntry/ReadingOrderEntry/SearchHit/Bookmark,ReadOptions/Preferences/TextOptions/ExportOptions/SearchOptions与ErrorCode新增docs/smoke/epub-smoke.ts编译样例, 覆盖书籍对象, 便捷层, 阅读器会话事件与控制, 错误类及负例
新增全局对象mail/$mail声明 (AutoJs6 6.8.0, 由 Angus Mail 插件提供):connect/connectAsync,setDefault,default,close,providers,accounts,MailError及转发到默认客户端的全部客户端方法新增Internal.Mail命名空间:Client与Operations(收发, 文件夹, 列表, 搜索, 读取, 附件与原文下载, 标记, 移动, 复制, 删除, 清除, 追加与监听的同步及Async形态),Watch事件发射器,Message/Attachment/Address/SendMessage,AccountOptions/Provider/SavedAccount,SearchQuery/SearchResult,Folder/FolderStatus/SendResult/SessionTestResult与ErrorCode新增docs/smoke/mail-smoke.ts编译样例, 覆盖别名与令牌连接, 搜索回退标记, 附件下载, 标记与移动, 监听事件及负例
更新全局代理Level/LogConfigurator/LogManager改为继承 AutoJs6 内置的org.autojs.autojs.core.console.log同名类,console.setGlobalLogConfig的示例与源码摘要同步 (宿主 6.8.0 以内置滚动文件日志器替换 log4j)更新三方库声明不再包含宿主已移除的库: log4j 与 android-logging-log4j, Flexmark, JavaMail, JUnit, github-api 与 Jackson, commons-io 与 commons-lang3, kotlin-reflect, SpongyCastle, media3 与 Guava (libraries.d.ts26,864 -> 25,081 行)更新合并 AutoJs6 6.8.0 (5282) 的主应用与资源声明: 新增org.autojs.autojs.core.console.log包 (Appender / Level / LogConfigurator / LogEvent / Logger / LoggerRepository / LogManager) 与邮件插件契约类, 资源 ID 随宿主增删