【TypeScript】声明文件

2024-01-07 19:47:25

一、定义

  • TypeScript 的声明文件包含 .d.ts 扩展名,并用于为 TypeScript 提供关于 JavaScript 代码的类型信息
  • 这些文件通常定义了接口、类型别名、类等,但并不包含实际的执行代码
  • 当你使用 JavaScript 库或框架时,声明文件就显得非常有用,因为它们帮助 TypeScript 理解库中对象的类型,以便于提供代码补全、类型检查和其他智能支持。

二、声明文件的使用

声明文件的一个用途是描述不是用 TypeScript 编写的 JavaScript 库的形状
例如:
如果你有一个名为 myLib.js 的简单 JavaScript 库,那么相应的声明文件 myLib.d.ts 会这样:

// myLib.d.ts
declare function myFunction(a: number): string;
declare class MyClass {
  constructor(s: string);
  myMethod(): number;
}

现在通过 myLib.d.ts 文件,TypeScript 编译器和编辑器就可以知道 myFunction 和 MyClass 的类型。在使用它们的 TypeScript 文件中,你可以直接引用这些声明:

// main.ts
/// <reference path="myLib.d.ts" />

let result: string = myFunction(5);
let myObject: MyClass = new MyClass("Hello");

三、声明模块

在第三方 JavaScript 库的声明中,你经常会看到模块被声明的样子。
通过声明模块,你可以导入一个模块并获得 TypeScript 类型的好处,就像这样:

// node_modules/@types/jquery/index.d.ts
declare module 'jquery' {
  export function $(selector: string): any;
}

// 使用时
import $ = require('jquery');
$('my-selector').doSomething();

四、DefinitelyTyped 和 @types

很多流行的 JavaScript 库在 DefinitelyTyped 仓库中都有对应的 .d.ts 类型声明文件,这使得在 TypeScript 项目中使用它们变得非常容易。你只需要运行 npm install @types/{library-name} 就能安装相应的类型定义包。

例如,如果需要使用 lodash 库,你可以安装类型包如下:

npm install --save @types/lodash

然后在代码中这样使用:

import _ from 'lodash';
_.padStart("Hello TypeScript!", 20, " ");

文章来源:https://blog.csdn.net/zhenshu_guo/article/details/135440299
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。