JS如何捆绑TypeScript声明文件
前话
TypeScript是JavaScript类型的超集
这是TypeScript的文档介绍的一句话,那么他们存在联系呢?
我的理解是,TypeScript在JavaScript基础上引入强类型语言的特性。开发者使用TypeScript语法进行编程开发,最终通过转换工具将TypeScript转换成JavaScript。
使用TypeScript能够避免在原生JavaScript上开发所带来的弱类型语言的坑。(我该输入啥?调用后返回啥?哎还是看看源码吧。。。)
嗯!很好,强类型的JavaScript,挺好的。但是,我舍不得那NPM里众多库无微不至的人文关怀啊o(TヘTo)
别怕,现在很多库已经悄悄地支持TypeScript,就算它无心支持,也有无私奉献的大佬们悄悄地帮这些库支持TypeScript了
这就是引出了本文的主题,TypeScript的声明文件,我认为它是JavaScript库类似C语言的头文件,它的存在便是帮助TypeScript引入JavaScript库
关于TypeScript声明文件的写法和规范请参考参考如下官方文档和优秀博文:
- https://www.tslang.cn/docs/handbook/declaration-files/introduction.html
- https://segmentfault.com/a/1190000009247663
根据官方文档介绍,有以下两个捆绑方式:
- 与你的npm包捆绑在一起
- 发布到npm上的@types organization
与npm包捆绑一起就是前面说的,开发者在ts项目中npm install一个库并在代码文件中import后直接即可使用。
当部分库官方不维护的时候,就可以通过第二个方式,在npm install一个库后,再执行 npm install @types/库名
安装库的声明文件即可使用。其原理是TypeScript在2.0版本之后,当你import 一个库的时候,当他在配置的include路径中未找到指定的库,就会在node_modules的@types中寻找该库。
一般来说,官方推荐第一种方式书写发布声明文件,下面我直接用例子来展示第一种捆绑方式吧。
例子
首先初始化TypeScript项目,目录结构如下:
tsconfig.json配置如下:
{"compilerOptions": {"target": "es5",/* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */"module": "commonjs",/* Specify module code generation: 'none', commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */"allowJs": true,"outDir": "./dist",/* Redirect output structure to the directory. *//* Allow javascript files to be compiled. */"strict": true /* Enable all strict type-checking options. */},"include": ["src/**/*"]
}
可以看到,我写了个模块 a
,并且给它捆绑了声明文件,模块 a
,即 src/a/index.js
内容如下:
const NAME = 'A';let call = (who) => {console.log('Hello ' + who + '! I am ' + NAME);
}export default {call
}
其声明文件即 src/a/index.d.ts
内容如下:
declare namespace a {function call(who: string): void;
}export default a;
这时,我们便可以在入口文件 src/index.ts
引入 a
模块:
import a from './a';
a.call('Pwcong');
命令行执行 tsc
后即可在目录 dist
中生成js代码:
执行命令 node ./dist/index.js
可以得到相应正确的输出。
我们再模拟导入发布后的NPM库,在 node_modules
目录下创建目录 b
,并初始化Node项目,这时目录结构如下:
其中 node_modules/b/types/package.json
内容如下:
{"name": "b","version": "1.0.0","main": "./src/index.js","types": "./types/index.d.ts"
}
node_modules/b/src/index.js
内容如下:
const NAME = 'B';let call = (who) => {console.log('Hello ' + who + '! I am ' + NAME);
}module.exports = {call
}
声明文件 node_modules/b/types/index.d.ts
内容如下:
declare namespace b {function call(who: string): void;
}export = b;
这时,我们修改 src/index.ts
:
import a from './a';
a.call('Pwcong');import b = require('b');
b.call('Pwcong');
命令行执行 tsc
后即可在目录 dist
中生成js代码后执行命令 node ./dist/index.js
也可以得到相应正确的输出。
转载于:https://www.cnblogs.com/pwc1996/p/8059454.html
JS如何捆绑TypeScript声明文件相关推荐
- c语言源码 文件绑捆,js捆绑TypeScript声明文件的方法教程
前话 TypeScript是JavaScript类型的超集,这是TypeScript的文档介绍的一句话,那么他们存在联系呢? 我的理解是,TypeScript在JavaScript基础上引入强类型语言 ...
- Autodesk Forge Viewer与Forge API Node.js客户端SDK的TypeScript声明文件发布!
作为一个凝聚专(jie)业(cao)精(man)神(man)的团队(Autodesk ADN),这大过?年的岂能没有一点表示?!花式红包什么的早已化境,技术分享大家也审low疲劳了,所以我们这就本着M ...
- php 得到 ts文件,获取TypeScript声明文件.d.ts步骤详解
这次给大家带来获取TypeScript声明文件.d.ts步骤详解,获取TypeScript声明文件.d.ts的注意事项有哪些,下面就是实战案例,一起来看一下. 一.TypeScript的声明文件就像C ...
- 如何编写 TypeScript 声明文件
1. 什么是 TS 声明文件 在 TypeScript 中以 .d.ts 为后缀的文件,称为 TypeScript 声明文件.它的作用是描述 JavaScript 模块内所有导出接口的类型信息. 2. ...
- 如何创建高质量的TypeScript声明文件(六) - 示例
2019独角兽企业重金招聘Python工程师标准>>> 转载 如何创建高质量的TypeScript声明文件(六) - 示例 继续上篇文章[如何创建高质量的TypeScript声明文件 ...
- 如何创建高质量的TypeScript声明文件(五) - 示例
2019独角兽企业重金招聘Python工程师标准>>> 转发 如何创建高质量的TypeScript声明文件(五) - 示例 前面四篇文章一起介绍了在声明文件中关于库结构的一些介绍,本 ...
- 在ts文件中引入js模块,编写声明文件的方法
一.声明文件的作用 在ts文件中引入js文件,由于js代码中没有类型约束,所以ts无法获得js代码的类型信息,进而会隐式推断js中类型为any,失去了ts代码类型推断和约束的作用,声明文件就是将一个j ...
- react-native 为本地js和开源库的js编写.d.ts声明文件
读书不觉已春深 !明日清明节 在使用Typescript编写程序RN过程中遇到困扰,且不论react,不论在浏览器中,只论写react-native的APP,怎么使用 declare声明文件 和 na ...
- TypeScript声明文件
声明文件简介 当使用第三方库时,我们需要引用它的声明文件,才能获得对应的代码补全.接口提示等功能. 什么是声明语句 假如我们想使用第三方库 jQuery,一种常见的方式是在 html 中通过 < ...
最新文章
- Spartan-6系列内部模块介绍之可配置逻辑模块(CLB)
- oracle的clob赋值_JAVA处理Oracle数据库CLOB读写操作
- 变量和指针——学习笔记
- 全国计算机等级考试题库二级C操作题100套(第59套)
- MyEclipse教程:Web开发——调试JSP
- 如何才能降低真机测试成本和建议所使用平台
- 如何解决AttributeError: ‘DataFrame‘ object has no attribute ‘sort‘
- 键盘代替鼠标工具 Vimac for Mac
- python包 —rdkit 安装
- 计算机快捷键屏幕保护是什么原因,电脑屏幕保护_电脑屏幕保护快捷键
- 软件测试中的可用性、可维护性、可靠性有什么区别?
- PPT中如何插入页码和母版修改
- 解决IDEA连接mysql时出现Server returns invalid timezone问题一劳永逸的方法
- vue 多行输入框显示行号
- C++17新特性总结
- 【OpenCV入门学习--python】图像的矩Image Moments
- URP——着色器和材质——复杂光照Complex Lit
- 用Vue+Node从零开始实现拼多多前后端商城项目 — 记录踩坑之旅(上篇)
- 小米6刷Ubuntu Touch系统
- 2020年中国热交换器行业分类、发展历程、现状及主要生产厂商分析「图」