【TypeScript】声明文件

一、定义

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

二、声明文件的使用

声明文件的一个用途是描述不是用 TypeScript 编写的 JavaScript 库的形状

例如:

如果你有一个名为 myLib.js 的简单 JavaScript 库,那么相应的声明文件 myLib.d.ts 会这样:

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 文件中,你可以直接引用这些声明:

ts 复制代码
// main.ts
/// <reference path="myLib.d.ts" />

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

三、声明模块

在第三方 JavaScript 库的声明中,你经常会看到模块被声明的样子。

通过声明模块,你可以导入一个模块并获得 TypeScript 类型的好处,就像这样:

ts 复制代码
// 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

然后在代码中这样使用:

ts 复制代码
import _ from 'lodash';
_.padStart("Hello TypeScript!", 20, " ");
相关推荐
Flynt6 小时前
AI 写的 Three.js 大屏,为什么越跑越卡?我在 Node 里复现了它的内存曲线
前端·ai编程·three.js
一个游离的指针8 小时前
Vue2:vue-router
前端·javascript·vue.js
火山引擎和TA的超级拍档们10 小时前
产品情报局 11 | AI 数据湖 LAS:打造大模型时代多模态数据底座
前端·后端
JavaGuide11 小时前
Gemini 真的变强了,写代码做视频的能力接近 Claude Opus5.5 了!
前端·ai编程
niceyayale11 小时前
WebRTC 延迟怎么调试:从 ICE 到 jitter buffer 的六个观测点
前端
aleimu11 小时前
Windows 11 右键打开 Cmder 2.0:从找不到菜单到默认使用 Cmder
前端·人工智能·后端
tryCbest11 小时前
Vue系列——第 20 篇:Vue Router 4——路由管理完全指南(上)
前端·javascript·vue.js
feixing_fx11 小时前
原始类型与引用类型:赋值时到底复制了什么
开发语言·前端·javascript·前端框架
一条破秋裤11 小时前
【1115】【多线程】【笔记】
前端·chrome·笔记
黑十11 小时前
FDE 怎么快速搭一个可演示页面?最小前端方案
java·大数据·前端·数据库·人工智能