@baidumap/jsapi-v4-types 是百度地图开放平台官方维护的 JSAPI 4.0 TypeScript 类型声明包,覆盖全部公开 API,是当前最完整、最准确的类型定义。安装后,编辑器能为 BMap.* 提供完整的代码补全、参数提示和悬停文档,同时也可作为 AI 编程助手的 API 参考上下文,帮助生成准确的地图开发代码。
npm install @baidumap/jsapi-v4-types --save-dev
包地址:https://www.npmjs.com/package/@baidumap/jsapi-v4-types
在 tsconfig.json 中添加类型引用:
{"compilerOptions": {"types": ["@baidumap/jsapi-v4-types"]}}
之后在任意 .ts 文件中直接使用 BMap 命名空间下的类型,无需额外 import:
即使项目不使用 TypeScript 编译,也可以在 JS 文件中获得智能提示。在项目根目录创建 jsconfig.json:
{"compilerOptions": {"types": ["@baidumap/jsapi-v4-types"]}}
VS Code 等编辑器会自动识别并提供 BMap.* 的代码补全和悬停文档。
类型声明文件包含完整的方法签名、参数说明和使用示例,是 AI 编程助手理解百度地图 API 的理想上下文。
在 Cursor、Codex、Claude Code、Windsurf、Trae等 AI IDE 中,安装类型包后 AI 会自动从 node_modules 读取类型信息。也可以手动将声明文件加入上下文:
@file node_modules/@baidumap/jsapi-v4-types/index.d.ts
启用后,AI 能够准确补全所有类的方法和属性、提示构造参数、识别废弃 API,并根据 @example 生成正确的代码。
类型声明只提供编辑器智能提示,不包含运行时代码。页面中仍需通过 script 标签加载 JSAPI:
<script src="https://api.map.baidu.com/api?v=4.0&ak=您的密钥"></script>
类型声明与 JSAPI 运行时互不干扰,仅在开发阶段生效。
上一篇
下一篇