类型文档。如何导入一个 node_modules/@types 并像 IncludeDeclarations 一样固定对它的引用

Pre*_*sto 5 documentation node-modules gruntjs typescript typedoc

我正在尝试生成我的应用程序的文档(使用 TypeDoc)。我有相当困难的场景要做。所以在我的代码中是一些函数,它返回类型为 from 的对象node_modules/@types。我需要将此类型包含在我的文档中,因为我需要显示对此的引用@type并且我也需要显示它@type。所以我正在尝试这些方法:

  1. 在“src”语句中添加了此类型的路径,例如:'**/node_modules/@types/someType/index.d.ts'。我的 TypeDoc 配置:

    typedoc: {
        build: {
            options: {
                module: 'commonjs',
                out: '../MyDocumentation/',
                name: 'MyApp',
                target: 'es5',
                exclude: [
                    '**/folderA/*.d.ts',
                    '**/folderB/*.d.ts'
                ],
                excludePrivate: true,
                externalPattern: "**/*/{fileX,fileY,fileZ}.ts",
                mode: 'file'
            },
            src: [
                'folderA/*.ts',
                'folderB/*.ts',
                '**/node_modules/@types/someType/*.d.ts'
            ]
        }
    }  
    
    Run Code Online (Sandbox Code Playgroud)
  2. 通过将 includeDeclarations 设置为 true。我的 TypeDoc 配置:

    typedoc: {
        build: {
            options: {
                module: 'commonjs',
                out: '../MyDocumentation/',
                name: 'MyApp',
                target: 'es5',
                exclude: [
                    '**/node_modules/**',
                    '**/folderA/*.d.ts',
                    '**/folderB/*.d.ts'
                ],
                includeDeclarations: true,
                excludePrivate: true,
                externalPattern: "**/*/{fileX,fileY,fileZ}.ts",
                mode: 'file'
            },
            src: [
                'folderA/*.ts',
                'folderB/*.ts',
            ]
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

第一种方式被忽略了。乍一看,我认为第二个运行良好,但我观察到了一些情况。我观察到全部node_modules已包含在我的文档中。但我不需要所有的node_modules到我的文档中。我只需要这一种。

我很失望,因为没有 includeDeclarations 我的文档无法找到node_modules类型,但使用它 - 包含大量冗余代码。

有什么办法吗?我正在寻找一种方法来包含我的@type但没有其余的node_modules.

2 天前我在GitHub 的 TypeDoc 存储库中问过,但还没有答案,所以我决定在这里创建一个问题。