繁体   English   中英

npm @types org包中的TypeScript类型

[英]TypeScript typings in npm @types org packages

我注意到有一个npm组织@types ,它包含输入包,但找不到任何文档。 这些意味着如何使用?

它是否意味着与打字工具一起使用? 如果是这样,如何安装它们? 例如,有一个@types/openlayers包,但是输入typings search npm:openlayers什么都不返回。

它是否意味着与打字工具分开使用? 例如直接用npm安装?

从TypeScript 2.0开始,不再需要打字 npm组织是设置开发人员团队的实体。 我相信Microsoft在npm中设置了@types组织,并将TypeScript开发团队添加到组织中。 在@types组织下软件包自动从DefinitelyTyped使用类型的出版商工具按已发布的文档

此外,还有另一种方法可以为您的包添加types

在你的package.json中

如果您的包有一个主.js文件,您还需要在package.json文件中指明主声明文件。 types属性设置为指向捆绑的声明文件。 例如:

{
    "name": "awesome",
    "author": "Vandelay Industries",
    "version": "1.0.0",
    "main": "./lib/main.js",
    "types": "./lib/main.d.ts"
}

请注意, "typings"字段与"types"同义,也可以使用。

另请注意,如果您的主声明文件名为index.d.ts并且位于包的根目录( index.js旁边),则不需要标记"types"属性,但建议这样做。

关于搜索类型

在大多数情况下,类型声明包应始终与npm上的包名称相同,但前缀为@ types /,但如果需要,可以查看https://aka.ms/types以查找包为你最喜欢的图书馆。

来自 - http://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html

但是当我在npm search @types/openlayers ,我没有得到任何结果。 但是从网络界面进行搜索确实会给我带来结果。 所以我猜npm search不会跨组织搜索。

TypeScript博客上的公告回答了这个问题: 宣言文件的未来

摘要:

@types npm组织用于获取npm类型定义。 使用这些类型定义是TypeScript 2.0中的一项功能。

这将取代目前的工程/工具,如分型TSD ,虽然这些会持续一段时间的支持。

这将是一个在Typescript 2.0中推出的功能。 这为UMD模块/库及其各自的定义提供了类型支持。

请参阅( 内置支持UMD模块定义 )以更好地了解当前环境类型的问题。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM