Typescript 的 d.ts 文件规范

参考:  https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html  

0. 仅在 d.ts 文件中使用的,只需要 declare 声明一下  

1. 将模块导出为全局变量,使用如下方法  

````

/*~ If this module is a UMD module that exposes a global variable 'myLib' when

*~ loaded outside a module loader environment, declare that global here.

*~ Otherwise, delete this declaration. */

export as namespace myLib;

````

 

2. 导出函数

````

/*~ If this module has methods, declare them as functions like so. */

export function myMethod(a: string): string;

export function myOtherMethod(a: number): number;

````

3.导出变量

````

/*~ If the module also has properties, declare them here. For example,

*~ this declaration says that this code is legal:

*~ import f = require('myFuncLibrary');

*~ console.log(f.defaultName); */

export const defaultName: string;

export let defaultLength: number;

````

4.导出类

````

/*~ Write your module's methods and properties in this class */

export class MyClass {

constructor(someParam?: string);

someProperty: string[];

myMethod(opts: MyClass.MyClassMethodOptions): number;

}

````

5.使用 namespace点 访问的元素需要声明在 namespace 中

````

/*~ If you want to expose types from your module as well, you can

*~ place them in this block.

*~

*~ Note that if you decide to include this namespace, the module can be

*~ incorrectly imported as a namespace object, unless

*~ --esModuleInterop is turned on:

*~ import * as x from '[~THE MODULE~]'; // WRONG! DO NOT DO THIS! */

declare namespace MyClass {

export interface MyClassMethodOptions { width?: number; height?: number; }

}

````

当我们使用 VS Code 进行 Git 提交时,有时会遇到忽略特定文件的情况。其中一种情况就是忽略 `components.d.ts` 文件,这是因为该文件不应被包含在项目的源代码中。 在项目中,`components.d.ts` 文件通常是由 TypeScript声明文件自动生成的,主要用于定义组件的类型和接口。由于它们不是实际的源代码,因此不应被包含在 Git 提交中。 为了忽略 `components.d.ts` 文件需要在项目的 `.gitignore` 文件中添加相应的规则。我们可以在 `.gitignore` 文件中添加类似以下的规则来忽略该文件: ``` # Ignore TypeScript declaration files *.d.ts # Ignore specific TypeScript declaration files components.d.ts ``` 以上规则将忽略所有以 `.d.ts` 结尾的声明文件以及 `components.d.ts` 文件。注意,在配置 `.gitignore` 文件时,需要在提交前进行修改,以便确保 Git 不会包含不必要的文件。 对于一个团队协作开发的项目而言,需要一个统一的开发规范,维护好 `.gitignore` 文件。除了 `components.d.ts` 文件以外,还有其他不需要被提交至 Git 的文件,如日志、缓存文件等,这些文件都可以通过 `.gitignore` 文件进行忽略,以确保项目源代码的整洁性和稳定性。 在项目的维护过程中,及时更新 `.gitignore` 文件也是非常必要的,尤其是在向项目中加入新的第三方库或框架时,需要检查是否需要忽略一些文件,以免不必要的麻烦。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值