react项目添加typescript类型定义文件 .d.ts

江月浓

最近用react + antd mobile + typescript开发项目，其中使用了rc-form这个包，可惜没有typescript版本，导致找不到类型定义。

一起来重温一下这个经典的错误。

D:/Code/test/src/pages/me/register/RegisterTest.tsx
TypeScript error in D:/Code/test/src/pages/me/register/RegisterTest.tsx(5,28):
File 'D:/Code/test/src/rc-form.d.ts' is not a module.  TS2306

    3 | import BrowserHistory from '../../../router/BrowserHistory';
    4 | import { AppUrls } from '../../../http/AppUrls';
  > 5 | import { createForm } from "rc-form";
      |                            ^
    6 | import MyToast from '../../../componets/MyToast';
    7 | 
    8 | export function RegisterTest(props: any) {

解决办法：

在网上查了很久，那些修改typeRoots的方法根本不好使，太坑人了。下面的方法绝对好用！

1. 修改项目根目录下的tsconfig.json文件，添加baseUrl选项，由于项目是用create-react-app创建的，这个值只能是src或者node_modules，推荐用src。

2. 编写类型定义文件rc-form.d.ts,内容如下：

declare module 'rc-form' {
    export const createForm: Function;
}

3. 将rc-form.d.ts放入项目的src目录下。

4. 在需要使用rc-form模块的文件里直接导入即可。

import { createForm } from "rc-form";

===

最新方法：

tsconfig这样配置，注意typeRoots要放到compilerOptions结点下面。

{
  "compilerOptions": {
    "target": "es6",
    "lib": [
      "dom",
      "dom.iterable",
      "esnext",
      "es2015"
    ],
    "allowJs": true,
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react",
    "baseUrl": "src",
    "typeRoots": [
      "src/custom_types",
      "node_modules/@types"
    ]
  },
  "include": [
    "src"
  ]
}

2. src目录下新建一个文件夹custom_types,放入类型定义文件，如下。

===

作者：zdd

出处：http://www.cnblogs.com/graphics/

本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利.

来源：https://www.cnblogs.com/graphics/p/13258855.html