• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

TypeScript声明文件(.d.ts)的使用

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

当我们在TS文件中需要引入外部库时,编译时是无法判断传入参数的类型的,所以我们需要在引入前加入一个声明文件来帮助ts判断类型。
当然现在大部分库都自带有自己的声明文件,一般在@types目录下。

使用场景

  1. 在ts文件中对引用的外部库做类型判断;
  2. 制作npm包时,书写自己的声明文件,需要在package.json的typing/types字段注册声明文件的路径;
  3. 不使用ts时,也可以添加声明文件与(自己的)的模块存放在同一目录下,简单做一下数据结构体,对IDE参数声明也有用哦;

引用声明文件的几种方法

  1. 与调用的ts文件放在同一目录下;
  2. 在声明文件tsconfig.json的include/files字段下添加声明文件的路径;

实例

  • 以外部库fs为例(假设fs没有自己的声明文件)

  • fs.d.ts

declare module 'fs' {
    function readFileSync(path: string | number, options?: { encoding?: string; flag?: string; } | null): string;
}
  • MyTest.ts
import * as fs from 'fs'

const body = fs.readFileSync('../@types/fs.d.ts', {encoding: 'utf8'});
console.log(body);

总结

  1. 声明文件一般只能声明外部引入的npm包;
  2. 声明文件一定要用declare module 'fs'显式的声明自己的外部库名称;

鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
[转载]TypeScript 入门指南发布时间:2022-07-18
下一篇:
使用Typescript重构axios(九)——异常处理:基础版发布时间:2022-07-18
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap