Question

我正在寻找一个完整的示例，或者至少为创建定义文件（不一定必须是tsd）的最佳实践，该库在@types中没有或包含在包中的JavaScript库

到目前为止，我已经能够将基本解决方案放在一起here，但它似乎没有遵循TypeScript网站上“定义”部分中给出的确切指导。

在上面的存储库中，我正在使用包@google-cloud/datastore，我知道它还没有tsd文件。文档足够好，我应该能够为我感兴趣的部分创建一个手动定义文件，但是我很难弄清楚出口这样的定义的最佳做法是什么。

具体来说，来自here，它说：

/*~ This is the module template file for class modules.
 *~ You should rename it to index.d.ts and place it in a folder with the same name as the module.
 *~ For example, if you were writing a file for "super-greeter", this
 *~ file should be 'super-greeter/index.d.ts'
 */

/*~ Note that ES6 modules cannot directly export class objects.
 *~ This file should be imported using the CommonJS-style:
 *~   import x = require('someLibrary');
 *~
 *~ Refer to the documentation to understand common
 *~ workarounds for this limitation of ES6 modules.
 */

/*~ If this module is a UMD module that exposes a global variable 'myClassLib' when
 *~ loaded outside a module loader environment, declare that global here.
 *~ Otherwise, delete this declaration.
 */

从上面的说明中，听起来我应该能够将index.d.ts文件放到我的node_modules/@types目录之外的文件夹中，该文件夹模仿与我的模块相同的文件夹结构。例如，在我的存储库中，我有一个包含index.ts文件的顶级目录@google-cloud/datastore，但是从文档中我听起来应该能够使用index.d.ts文件;但是，我的模块，编译器都能找到它。我需要一个编译器选项吗？

其次，我在存储库中采取的方法是否正确。这种方式没有记录在他们的网站上，在得出解决方案之前我不得不猜测它。我实际上是将JavaScript包google-cloud/datastore导入index.ts，添加我的输入，然后将其导出以供我的模块使用。但是，我的模块必须通过./@google-cloud/datastore引用包，因为这是TypeScript定义的实际位置。

简而言之，在TypeScript v2.2.2中，为不包含tsd的JavaScript库创建小型本地TypeScript定义文件的最佳做法是什么？

后果

我使用Alex建议的解决方案更新了我的存储库，一切似乎都按预期工作。我想要注意的是，它似乎也只是添加一个{ "baseUrl": "types" }参数，但我不清楚为什么这是正确的所以我采用了建议的方法。 --traceResolution标志对此非常有帮助。

在此示例中，我确保还包含另一个带有TypeScript定义的模块lodash，以确保正常的模块分辨率仍然正确。

我的目录/文件结构：

+ js
  ...
+ node_modules
  + @google-cloud
    + datastore
  + lodash
  + @types
    + lodash
  + ...
+ types
  + @google-cloud
  - index.d.ts
  + datastore
    -  index.d.ts 
- index.ts
- package.json
- tsconfig.json

跟踪分辨率

只是为了好奇，我想通过调用tsc --traceResolution发布错误/正确结果的示例。为了清晰起见，我缩写了结果。

没有paths参数的

不正确 TypeScript会将@google-cloud/datastore解析为index.js文件，这是错误的。

======== Module name '@google-cloud/datastore' was successfully resolved to 'C:/Users/Kory/Documents/Repos/playground/manual-typescript-definition/node_modules/@google-cloud/datastore/src/index.js'. ========

使用paths参数

更正。请注意，@google-cloud/datastore解析为index.d.ts文件，而不是JavaScript文件。

======== Module name '@google-cloud/datastore' was successfully resolved to 'C:/Users/Kory/Documents/Repos/playground/manual-typescript-definition/types/@google-cloud/datastore/index.d.ts'. ========

Answer 1

您可以使用compilerOptions paths和typeRoots来tsc来检测自定义.d.ts文件。它将在列出的目录中搜索与您的包匹配的文件夹（即@google-cloud/datastore）

例如

"paths": {
  "*": [
    "types/*"
  ]
},
"typeRoots": [
  "./types"
]

其中types是目录结构根目录下的文件夹，并且您创建了一个文件types/@google-cloud/datastore/index.d.ts

您可以使用tsc --traceResolution快速查看tsc在搜索类型定义时正在考虑的文件/文件夹

在TypeScript v2.2.2中，如何为没有tsd的Javascript库创建定义文件？

后果

跟踪分辨率

1 个答案: