使用TypeScript来开发Node程序

2021-06-05

都2021年了, 竟然Vue3都已经使用TypeScript来开发了. 感觉TypeScript已经快要统一JavaScript宇宙了, 所以称现在年前感觉去学习一下使用TypeScript来开发Node的应用.

环境依赖

NodeJS
yarn

创建项目

新建项目文件夹

1
2
3

mkdir node-ts
cd node-ts
yarn init

安装所需依赖

1	yarn add -D typescript ts-node

新建源码目录以及项目文件

1 2	mkdir src echo "console.log('Hello TypeScript!')" >> index.ts

运行起来吧

打开package.json文件, 编写下面的"scripts"中"test"的值, 修改为”ts-node src/main”

1
2
3

vim package.json
- "test": "echo \"Start Test !\""
+ "test": "ts-node src/index"

保存之后直接输入yarn test就可以执行src/index

1 2	$ yarn test Hello TypeScript!

生产编译文件

编译代码的话需要搞一些 typescript 的配置文件

1	touch tsconfig.json

直接打开tsconfig.json文件, 输入以下内容

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es5",
    "allowJs": true,
    "noImplicitAny": true,
    "outDir": "./dist",
    "sourceMap": false
  },
  "include": [
    "src/**/*"
  ]
}

然后再打开package.json文件, 在"scripts"字段中添加一行"build":"tsc"

1
2
3

- "test": "ts-node src/index"
+ "test": "ts-node src/index",
+ "build": "tsc"

再执行yarn build命令, TypeScript就会自动把src/index.ts编译到dist目录下了

$ yarn build
yarn run v1.22.10
$ tsc
Done in 4.67s.

Node 类型定义声明

现在我们已经可以使用TypeScript进行Node开发了, 但是当我们import * as fs from 'fs';使用Node的内置库时, 会发现根本编译不过, 这个时候我们就需要安装Node的类型定义库了

1	yarn add -D @types/node

如果还使用了第三方的js库也, 它却没有类型定义文件(*.d.ts), 我们都可以使用这个命令去查找是否有现成的类型定义文件, 如果没有只能自己去定义然后使用咯.

1	yarn add -D @types/jquery