当前位置: 代码网 > it编程>编程语言>Javascript > typescript常见高级技巧总结

typescript常见高级技巧总结

2024年05月18日 • Javascript •我要评论
用了一段时间的 typescript 之后,深感中大型项目中 typescript 的必要性,它能够提前在编译期避免许多 bug,如很恶心的拼写问题。而越来越多的 package 也开始使用 ts,学

用了一段时间的 typescript 之后,深感中大型项目中 typescript 的必要性,它能够提前在编译期避免许多 bug,如很恶心的拼写问题。而越来越多的 package 也开始使用 ts,学习 ts 已是势在必行。

以下是我在工作中总结到的比较实用的 typescript 技巧。

01 keyof

keyof 与 object.keys 略有相似,只不过 keyof 取 interface 的键。

interface point {
    x: number;
    y: number;
}

// type keys = "x" | "y"
type keys = keyof point;

假设有一个 object 如下所示,我们需要使用 typescript 实现一个 get 函数来获取它的属性值

const data = {
  a: 3,
  hello: 'world'
}

function get(o: object, name: string) {
  return o[name]
}

我们刚开始可能会这么写,不过它有很多缺点

  • 无法确认返回类型:这将损失 ts 最大的类型校验功能
  • 无法对 key 做约束:可能会犯拼写错误的问题

这时可以使用 keyof 来加强 get 函数的类型功能,有兴趣的同学可以看看 _.get 的 type 标记以及实现

function get<t extends object, k extends keyof t>(o: t, name: k): t[k] {
  return o[name]
}

02 required & partial & pick

既然了解了 keyof,可以使用它对属性做一些扩展, 如实现 partial 和 pick,pick 一般用在 _.pick 中

type partial<t> = {
  [p in keyof t]?: t[p];
};

type required<t> = {
  [p in keyof t]-?: t[p];
};

type pick<t, k extends keyof t> = {
  [p in k]: t[p];
};

interface user {
  id: number;
  age: number;
  name: string;
};

// 相当于: type partialuser = { id?: number; age?: number; name?: string; }
type partialuser = partial<user>

// 相当于: type pickuser = { id: number; age: number; }
type pickuser = pick<user, "id" | "age">

这几个类型已内置在 typescript 中

03 condition type

类似于 js 中的 ?: 运算符,可以使用它扩展一些基本类型

t extends u ? x : y

type istrue<t> = t extends true ? true : false
// 相当于 type t = false
type t = istrue<number>

// 相当于 type t = false
type t1 = istrue<false>

04 never & exclude & omit

官方文档对 never 的描述如下

the never type represents the type of values that never occur.

结合 never 与 conditional type 可以推出很多有意思而且实用的类型,比如 omit

type exclude<t, u> = t extends u ? never : t;

// 相当于: type a = 'a'
type a = exclude<'x' | 'a', 'x' | 'y' | 'z'>

结合 exclude 可以推出 omit 的写法

type omit<t, k extends keyof any> = pick<t, exclude<keyof t, k>>;

interface user {
  id: number;
  age: number;
  name: string;
};

// 相当于: type pickuser = { age: number; name: string; }
type omituser = omit<user, "id">

05 typeof

顾名思义,typeof 代表取某个值的 type,可以从以下示例来展示他们的用法

const a: number = 3

// 相当于: const b: number = 4
const b: typeof a = 4

在一个典型的服务端项目中,我们经常需要把一些工具塞到 context 中,如config,logger,db models, utils 等,此时就使用到 typeof。

import logger from './logger'
import utils from './utils'

interface context extends koacontect {
  logger: typeof logger,
  utils: typeof utils
}

app.use((ctx: context) => {
  ctx.logger.info('hello, world')

  // 会报错,因为 logger.ts 中没有暴露此方法,可以最大限度的避免拼写错误
  ctx.loger.info('hello, world')
})

06 is

在此之前,先看一个 koa 的错误处理流程,以下是对 error 进行集中处理,并且标识 code 的过程

app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    let code = 'bad_request'
    if (err.isaxioserror) {
      code = `axios-${err.code}`
    } else if (err instanceof sequelize.baseerror) {

    }
    ctx.body = {
      code
    }
  }
})

在 err.code 处,会编译出错,提示 property 'code' does not exist on type 'error'.ts(2339)。

此时可以使用 as axioserror 或者 as any 来避免报错,不过强制类型转换也不够友好

if ((err as axioserror).isaxioserror) {
  code = `axios-${(err as axioserror).code}`
}

此时可以使用 is 来判定值的类型

function isaxioserror (error: any): error is axioserror {
  return error.isaxioserror
}

if (isaxioserror(err)) {
  code = `axios-${err.code}`
}

在 graphql 的源码中,有很多诸如此类的用法,用以标识类型

export function istype(type: any): type is graphqltype;

export function isscalartype(type: any): type is graphqlscalartype;

export function isobjecttype(type: any): type is graphqlobjecttype;

export function isinterfacetype(type: any): type is graphqlinterfacetype;

07 interface & type

interface 与 type 的区别是什么?可以参考以下 stackoverflow 的问题

stackoverflow.com/questions/3…

一般来说,interface 与 type 区别很小,比如以下两种写法差不多

interface a {
  a: number;
  b: number;
};

type b = {
  a: number;
  b: number;
}

其中 interface 可以如下合并多个,而 type 只能使用 & 类进行连接。

interface a {
    a: number;
}

interface a {
    b: number;
}

const a: a = {
    a: 3,
    b: 4
}

08 record & dictionary & many

这几个语法糖是从 lodash 的 types 源码中学到的,平时工作中的使用频率还挺高。

type record<k extends keyof any, t> = {
    [p in k]: t;
};

interface dictionary<t> {
  [index: string]: t;
};

interface numericdictionary<t> {
  [index: number]: t;
};

const data:dictionary<number> = {
  a: 3,
  b: 4
}

09 使用 const enum 维护常量表

相比使用字面量对象维护常量,const enum 可以提供更安全的类型检查

// 使用 object 维护常量
const todo_status {
  todo: 'todo',
  done: 'done',
  doing: 'doing'
}
// 使用 const enum 维护常量
const enum todo_status {
  todo = 'todo',
  done = 'done',
  doing = 'doing'
}

function todos (status: todo_status): todo[];

todos(todo_status.todo)

10 vs code tips & typescript command

使用 vs code 有时会出现,使用 tsc 编译时产生的问题与 vs code 提示的问题不一致

找到项目右下角的 typescript 字样,右侧显示它的版本号,可以点击选择 use workspace version,它表示与项目依赖的 typescript 版本一直。

或者编辑 .vs-code/settings.json

{
  "typescript.tsdk": "node_modules/typescript/lib"
}

11 typescript roadmap

最后一条也是最重要的一条,翻阅 roadmap,了解 ts 的一些新的特性与 bug 修复情况。

赞 (0)

相关文章:

版权声明:本文内容由互联网用户贡献,该文观点仅代表作者本人。本站仅提供信息存储服务,不拥有所有权,不承担相关法律责任。 如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 2386932994@qq.com 举报,一经查实将立刻删除。

发表评论

验证码:
Copyright © 2017-2026  代码网 保留所有权利. 粤ICP备2024248653号
站长QQ:2386932994 | 联系邮箱:2386932994@qq.com