3

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

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

在上面的存储库中，我正在使用 package @google-cloud/datastore，据我所知还没有 tsd 文件。该文档足够好，我应该能够为我感兴趣的部分创建手动定义文件，但是我很难弄清楚手动导出此类定义的最佳实践是什么。

具体来说，从这里，它说：

/*~ 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目录之外的文件夹中，该文件夹模仿与我的模块相同的文件夹结构。例如，在我的存储库中，我有一个@google-cloud/datastore包含 index.ts 文件的顶级目录，但是从文档中听起来我应该能够使用 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

跟踪分辨率

只是出于好奇，我想发布一个不正确/正确结果的示例 call tsc --traceResolution。为了清楚起见，我对结果进行了缩写。

Incorrect没有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'. ========
4

1 回答 1

1

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

例如

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

types目录结构根目录的文件夹在哪里，您创建一个文件types/@google-cloud/datastore/index.d.ts

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

于 2017-04-20T04:32:06.453 回答