如何通过 TypeScript 的 as const 配合 JSDoc 实现精准的代码提示与常量保护

轻墨大大_1475

轻墨大大_1475

2026-04-16

1039人浏览

原创

as const不能用于jsdoc,因其是ts专有语法,jsdoc仅支持标准js语法和类型伪函数;正确做法是ts中用as const定义常量并导出类型,jsdoc中通过@type {typeof xxx[number]}引用推导出的字面量类型。

如何通过 typescript 的 as const 配合 jsdoc 实现精准的代码提示与常量保护

as const 本身不能直接用于 JSDoc

这是最容易踩的第一个坑:as const 是 TypeScript 编译器专用语法,JSDoc 注释里写 as const 会直接报错(SyntaxError: Unexpected token 'as')。JSDoc 只支持标准 JS 语法 + 类型伪函数(如 import()),不解析 TS 特有断言。所以别在 /** @type {...} */ 里塞 as const —— 它根本不会被识别。

用 as const 声明常量,再用 @type 引用其推导出的字面量类型

真正可行的链路是:先在 TS 文件中用 as const 定义一个不可变值,让编译器推导出精确的字面量类型(比如 readonly ["user", "admin"] 或 { id: 1, name: "test" } & { readonly id: 1; readonly name: "test" }),然后在 JSDoc 中通过 @type 直接引用这个已存在的常量名或其类型。

  • TS 文件中定义:
    const ROLES = ["user", "admin"] as const;
    export type Role = typeof ROLES[number]; // "user" | "admin"
  • JSDoc 中复用:
    /** @type {Role} */ let currentRole = "user";
  • 如果不想导出类型,也可直接引用:
    /** @type {typeof ROLES[number]} */ let currentRole = "user";

对象嵌套时 as const 的深度限制与 JSDoc 替代方案

as const 对嵌套对象默认只做浅层冻结 —— 外层属性变成只读,但深层对象仍可能被修改(除非每层都显式加 as const)。而 JSDoc 没法补这个缺口,它只能标注类型,不能改变运行时行为。

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
  • 危险写法(看似只读,实则可改):
    const config = {
      api: { baseUrl: "https://api.example.com" },
      features: { enabled: true }
    } as const;
    config.api.baseUrl = "http://hacked.com"; // ❌ TypeScript 报错(因为 api 是 readonly)
    config.features.enabled = false; // ❌ 同样报错
    // 但注意:config.api 本身是对象字面量,其内部属性没被递归冻结
  • 安全写法(逐层 as const):
    const config = {
      api: { baseUrl: "https://api.example.com" } as const,
      features: { enabled: true } as const
    } as const;
  • JSDoc 中无法自动继承这种“多层只读”,必须手动写出完整字面量类型或依赖 TS 编译后生成的声明文件

为什么不能跳过 as const,直接在 JSDoc 里写字面量类型?

可以写,但维护成本爆炸。比如你想标注一个按钮状态数组:["primary", "secondary", "danger"],在 JSDoc 里硬写 @type {readonly ["primary", "secondary", "danger"]} 看似可行,但一旦后端新增状态,你得同步改三处:数据源、JSDoc 类型、所有消费该数组的逻辑判断 —— 而用 as const 定义源头,再用 typeof XXX[number] 引用,改一处就全链更新。

更关键的是:JSDoc 不校验字面量值是否真实存在于数组中。如果你写 @type {"primary" | "warning"},但实际数组里根本没有 "warning",编辑器不会提醒;而 as const + typeof 是从真实值推导,天然保真。

真正容易被忽略的点在于:as const 的保护只作用于编译期类型检查,不阻止运行时篡改(比如通过 Object.defineProperty 绕过)。如果你需要运行时防护,得额外加 Object.freeze(),且必须作用于每一层嵌套对象 —— 这和 JSDoc 或类型系统完全无关,是纯 JS 行为。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3269

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2348

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1280

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1238

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2218

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3560

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16395

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习