用 js-doc + typescript 给项目更好的类型标注

从 ts 文件引入 js 文件的时候(js 引入 js 文件同理),ts 文件中只能基于变量的默认值推断出一个类型,但是如果初始值是 null,谁也不知道这个变量最后被赋值了什么类型,那么怎么解决呢

首先 jsdoc 基本语法 (vscode && webstorm 自带)

js 文件

class C {  /**   * @type {string}   */  person = "";}

当我们把鼠标移动到 person 上,可以看到

这个时候你可能会说,不对啊,我就不写这个类型标注,本来 vscode 和 webstorm 就能推断出 person 类型是字符串但是,如果 person 的初始值是 null 呢像这样

这时候 person 的类型就变成了 null,使用的时候也不够友好,因为我们不知道这个 person 初始化的时候是被赋值了什么类型,是对象,数字,还是字符串,都没法知道,这时候使用 js-doc 就可以解决这个问题

会推断出

如果 person 是对象

推断出

使用的时候也有对应的提示

引入外部类型

上面的写法还不错,但是仅限于类型,属性名不多,不复杂的时候,如果有几十个属性,就会发生这种代码变得很长,且不利于阅读的情况

export class B {  /**   * @type {{   * age:number,   * name:string,   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * gender:number   * }}   */  person = {    gender: 0  };}

那怎么解决这个问题呢

js-doc 也支持从外部 ts 中引入类型,然后在 @type 中进行标注

先定义类型

export enum Gender {  male,  female,}export type B_PERSON_TYPE = {  gender: Gender;  age: number;} | null;

然后在刚刚的 js 文件中引入

import { B_PERSON_TYPE } from "./constant";export class B {  /**   * @type {B_PERSON_TYPE}   */  person = {    gender: {      datum: "12",      list: "123123",    },  };}

之后就可以看到编辑器将 person 推断为我们外部引入的 ts 类型了

Vue 中使用

就算 js 中可以正确标注类型了,可能又有人问了,我平时写的都是 vue,vue 中怎么用呢?答案是,直接就可以使用

export class B {  /**   * @type {{age:number}|null}   */  person = null;}

像这样直接标注好,然后 vue 文件中就会伴有提示了

不过如果是 vue 项目,更推荐使用 defineComponent 函数包裹,可以获得更好的类型推断体验

vue2 使用 @vue/composition-api 这个库,vue3 内置此函数

本文使用 文章同步助手 同步

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,743评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,296评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,285评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,485评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,581评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,821评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,960评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,719评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,186评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,516评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,650评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,329评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,936评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,757评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,991评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,370评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,527评论 2 349

推荐阅读更多精彩内容