Skip to content

About

AutoJs6 声明文件 (d.ts) AutoJs6 TypeScript Declarations

Topics

Resources

Stars

55 stars

Watchers

1 watching

Forks

Repository files navigation

AutoJs6 TypeScript Declarations

语言 (Languages)

autojs6-ts-declarations-banner_1024×310

AutoJs6 声明文件 (d.ts)

TypeScript Declarations for AutoJs6

Version name GitHub issues GitHub AutoJs6 repository GitHub top language
Created GitHub License GitHub Code Size JetBrains supporter


功能简介


实现或增强开发工具的代码智能补全功能:


样例展示


点击展开或收起样例展示

autojs6-ts-declarations-demo

使用说明


[ 1 ] - 获取声明文件 (d.ts) 的主目录

可以从 NPM 或 GitHub 获取主目录.

从 NPM 获取 (推荐)
npm i @sm003/autojs6-dts

安装后, 定位到 /node_modules/@sm003/autojs6-dts/declarations.

从 GitHub 获取

下载最新项目 zip 数据包, 解压后得到 declarations 文件夹.

[ 2 ] - 放置声明文件的主目录

如使用 WebStorm, 此步骤可略过.

将主目录放置到项目的任意目录中.

假设用户有一个名为 hello 的项目, 项目目录结构如下:

hello / images / ... hello / docs / ... hello / main.js hello / project.json ... ...

则 declarations 主目录支持以下方式放置:

hello / declarations / (推荐) hello / images / declarations / hello / docs / declarations / hello / ... / ... / declarations /

但不能放置在项目的同级或上级目录中.

[ 3 ] - 实现或增强代码智能补全

开发工具会自动识别并开始索引所有声明文件.

索引完成后开始编写代码并体验代码智能提示.

注: 部分编辑器可能需要重新启动才能开始声明文件的索引.

[ 4 ] - VSCode 编辑器的额外配置

VSCode 可能无法像 WebStorm 一样识别任意位置的 declarations 文件夹, 尤其是使用 npm 命令部署后, declarations 文件夹更是难以被 VSCode 默认识别. 因此需要将 jsconfig.json 文件复制到项目根目录中, 如:

hello / node_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 可实现或增强代码智能补全.

JSOX 按需扩展

仅在脚本实际启用 JSOX 扩展时引用以下入口. index.d.ts 默认不加载这些声明. 若编辑器会扫描全部本地声明文件, 默认排除 aj6-jsox-*-extensions.d.ts, 再显式引用需要的入口.

/// <reference path="./declarations/autojs6/aj6-jsox-extensions.d.ts" />
jsox.extendAll();
const values = [1, 2, 2].distinct();
const parsed = Number.parseFloat('ff', 16);

仅启用一个模块时, 选择 aj6-jsox-array-extensions.d.ts, aj6-jsox-number-extensions.d.ts 或 aj6-jsox-math-extensions.d.ts, 并调用对应的 jsox.extend. 第三方库声明覆盖打包的常用核心 API; Dayjs 可选插件需要单独声明, Axios 浏览器适配器未实现的能力不会被声明为完整浏览器 API.


获取更新


从 NPM 直接获取更新:

npm update @sm003/autojs6-dts

如需检查更新, 除直接到 当前项目主页 查看外, 还可定位到项目根目录的 package.json 文件, 鼠标悬停在 @sm003/autojs6-dts 依赖项的版本值处, 在浮动窗口中可查看是否存在版本更新. 另外 VSCode 也可借助 Version Lens 插件实现版本更新检查.

通常情况下, AutoJs6 发布版本更新后, 声明文件项目也会伴随更新.


更新日志

v4.42.0

2026/10/16
  • 新增 files.batchRename 的 preview, presets, importPresets 及其异步形态, deleteHistory 与 clearHistory, 拼音 / 照片元数据 / 命名预设选项及方案条目的 metadataMissing, 对应 Batch Rename 插件的单名试算, 命名预设, 元数据变量, 汉字转拼音与历史清理
  • 提示 需要配套宿主 6.8.0 与 Batch Rename 插件 1.1.0

v4.41.0

2026/10/16
  • 新增 plugins.tools 及其工具, 提供者, 调用选项与结果类型, 对应 AutoJs6 插件自描述的工具: 列出, 同步与异步调用, 图片 / 文件 / 目录参数与输出文件
  • 提示 需要配套宿主 6.8.0 及提供工具的插件

v4.40.0

2026/10/15
  • 新增 files.batchRename 及其选项, 方案, 结果, 撤销与历史类型和 BatchRenameError, 对应 Batch Rename 插件的方案预览, 逐项排除, 执行, 撤销与历史批次
  • 提示 需要配套宿主 6.8.0 / 5438 与 Batch Rename 插件 1.0.0

完整更新日志

多语言文档

请编辑 .readme/ 与 .changelog/ 中的语言 JSON 和模板后重新生成文档, 不要直接修改生成的 Markdown. 根 README 使用简体中文. 下列命令需要 Python 3.10 或更新版本, 无需额外 Python 包; Windows 可用 py 替代 python. --check 只读校验语言集合, 字段, 历史版本与日期, 标点和生成结果, CI 同样执行此检查.

python .python/generate_markdown.py
python .python/generate_markdown.py --check
python -m unittest discover -s .python/tests

About

AutoJs6 声明文件 (d.ts) AutoJs6 TypeScript Declarations

Topics

Resources

Stars

55 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages