js捆绑TypeScript声明使用详解

这次给大家带来js捆绑TypeScript声明使用详解,js捆绑TypeScript声明的注意事项有哪些,下面就是实战案例,一起来看一下。

前话

TypeScript是注意事项类型的超集,这是TypeScript的文档介绍的一句话,那么他们存在联系呢?

我的理解是,TypeScript在JavaScript基础上引入强类型语言的特性。开发者使用TypeScript语法进行编程开发,最终通过转换工具将TypeScript转换成JavaScript。

使用TypeScript能够避免在原生JavaScript上开发所带来的弱类型语言的坑。(我该输入啥?调用后返回啥?哎还是看看源码吧。。。)

嗯!很好,强类型的JavaScript,挺好的。但是,我舍不得那NPM里众多库无微不至的人文关怀啊o(TヘTo)

别怕,现在很多库已经悄悄地支持TypeScript,就算它无心支持,也有无私奉献的大佬们悄悄地帮这些库支持TypeScript了

这就是引出了本文的主题,TypeScript的声明文件,我认为它是JavaScript库类似C语言的头文件,它的存在便是帮助TypeScript引入JavaScript库

什么是声明文件?

和 C/C++ 的 *.h 头文件(Header files)非常相似:当你在 C/C++ 程序中引用了一个第三方库(.lib/.dll/.so/.a/.la)时,C/C++ 编译器无法自动地识别库内导出名称和函数类型签名等,这就需要使用头文件进行接口声明了。

同理地,TypeScript 的声明文件是一个以 .d.ts 为后缀的 TypeScript 代码文件,但它的作用是描述一个 JavaScript 模块(广义上的)内所有导出接口的类型信息。

关于TypeScript声明文件的写法和规范请参考参考如下官方文档和优秀博文:

注意事项www.tslang.cn/docs/handbook/declaration-files/introduction.html

http://www.jb51.net/article/138217.htm

根据官方文档介绍,有以下两个捆绑方式:

与你的npm包捆绑在一起

发布到npm上的@types organization

与npm包捆绑一起就是前面说的,开发者在ts项目中npm install一个库并在代码文件中import后直接即可使用。

当部分库官方不维护的时候,就可以通过第二个方式,在npm install一个库后,再执行 npm install @types/库名 安装库的声明文件即可使用。其原理是TypeScript在2.0版本之后,当你import 一个库的时候,当他在配置的include路径中未找到指定的库,就会在node_modules的@types中寻找该库。

一般来说,官方推荐第一种方式书写发布声明文件,下面我直接用例子来展示第一种捆绑方式吧。

例子

首先初始化TypeScript项目,注意事项如下:

js捆绑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代码:

js捆绑TypeScript声明使用详解

执行命令 node ./dist/index.js 可以得到相应正确的输出。

我们再模拟导入发布后的NPM库,在 node_modules 目录下创建目录 b ,并初始化Node项目,这时目录结构如下:

js捆绑TypeScript声明使用详解

其中 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 也可以得到相应正确的输出。

相信看了本文案例你已经掌握了方法,更多精彩请关注【创想鸟】其它相关文章!

推荐阅读:

注意事项

注意事项

以上就是js捆绑TypeScript声明使用详解的详细内容,更多请关注【创想鸟】其它相关文章!

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

发布者:PHP中文网,转转请注明出处:https://www.chuangxiangniao.com/p/2766434.html

(0)
上一篇 2025年3月8日 11:14:16
下一篇 2025年2月25日 19:38:43

AD推荐 黄金广告位招租... 更多推荐

相关推荐

  • d.ts文件使用详解

    这次给大家带来d.ts文件使用详解,使用d.ts文件的注意事项有哪些,下面就是实战案例,一起来看一下。 前言 本文主要讲怎么写一个typescript的描述文件(以d.ts结尾的文件名,比如xxx.d.ts)。 最近开始从js转ts了。但是…

    2025年3月8日 编程技术
    200
  • vue render开发实例详解

    这次给大家带来vue render开发实例详解,vue render开发的注意事项有哪些,下面就是实战案例,一起来看一下。 简介 在使用Vue进行开发的时候,大多数情况下都是使用template进行开发,使用template简单、方便、快捷…

    编程技术 2025年3月8日
    200
  • JS实现文本字体打印界面

    这次给大家带来JS实现文本字体打印界面,JS实现文本字体打印界面的注意事项有哪些,下面就是实战案例,一起来看一下。 具体代码如下: 打字效果 登录后复制 p { width:980px; margin:10px auto; backgrou…

    编程技术 2025年3月8日
    200
  • Koa项目搭建步骤详解

    这次给大家带来Koa项目搭建步骤详解,Koa项目搭建的注意事项有哪些,下面就是实战案例,一起来看一下。 本文介绍了Koa项目搭建过程详细记录,分享给大家,具体如下: Java中的Spring MVC加MyBatis基本上已成为Java We…

    2025年3月8日
    200
  • 编写d.ts文件步骤详解

    这次给大家带来编写d.ts文件步骤详解,编写d.ts文件的注意事项有哪些,下面就是实战案例,一起来看一下。 前言 本文主要讲怎么写一个typescript的描述文件(以d.ts结尾的文件名,比如xxx.d.ts)。 最近开始从js转ts了。…

    2025年3月8日 编程技术
    200
  • vue配置请求本地json数据需要哪些步骤

    这次给大家带来vue配置请求本地json数据需要哪些步骤,vue配置请求本地json数据的注意事项有哪些,下面就是实战案例,一起来看一下。 在build文件夹下找到webpack.dev.conf.js文件,在const portfinde…

    编程技术 2025年3月8日
    200
  • JS实现JSON数组去重步骤详解

    这次给大家带来JS实现JSON数组去重步骤详解,JS实现JSON数组去重的注意事项有哪些,下面就是实战案例,一起来看一下。 需求描述:去除JSON数组中paymode字段相同的项,并将paymoney累加。 paylist:[{paymod…

    编程技术 2025年3月8日
    200
  • JS几种数组遍历方法总结及对比

    这次给大家带来JS几种数组遍历方法总结及对比,JS几种数组遍历方法总结及对比的注意事项有哪些,下面就是实战案例,一起来看一下。 前言 这一篇与上一篇 JS几种变量交换方式以及性能分析对比 属于同一个系列,本文继续分析JS中几种常用的数组遍历…

    2025年3月8日
    400
  • Mac里怎么安装nodejs

    这次给大家带来Mac里怎么安装nodejs,Mac里怎么安装nodejs的安装有哪些,下面就是实战案例,一起来看一下。 首先是打开node  nodejs 然后你会看见如下安装   点击上面的任何一个都可以完成下载,下载完成之后找到文件,一…

    2025年3月8日 编程技术
    200
  • vue-cli 3.0.x 入门详解

    这次给大家带来vue-cli 3.0.x 入门详解,vue-cli 3.0.x 使用的注意事项有哪些,下面就是实战案例,一起来看一下。 最近项目正在优化。乘着有时间看了一下 vue-cli3.0.x 使用 。感觉还蛮不错的。 因为之前项目使…

    编程技术 2025年3月8日
    200

发表回复

登录后才能评论