marijnh/getdocs-ts

Extract builddocs-style info from typescript sources

getdocs-ts's Issues

`Unknown type parameter K` for typescript internal utilities

Give this test file:

export type A = {
    foo: 'bar';
    bar: string;
};
export type B = Omit<A, 'foo'>;

The package will throw an error like:

Error: Unknown type parameter K
    at Context.getType (/Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:179:23)
    at Context.getTypeParam (/Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:454:62)
    at Context.getType (/Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:213:67)
    at Context.itemForSymbol (/Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:96:22)
    at Context.gatherSymbols (/Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:28:47)
    at /Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:692:125
    at Array.map (<anonymous>)
    at gatherMany (/Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:675:18)
    at gather (/Users/mirone/Code/unplugin-tsdoc/node_modules/.pnpm/[email protected]/node_modules/getdocs-ts/src/index.js:665:12)
    at file:///Users/mirone/Code/unplugin-tsdoc/demo.js:12:15

Additional information:

I found out that the maybeDecl(type.symbol)?.parent?.kind is equal to SyntaxKind.TypeAliasDeclaration here.

    if (type.flags & TypeFlags.TypeParameter) {
      let name = type.symbol.name, found = this.typeParams.find(p => p.name == name)
      if (!found && maybeDecl(type.symbol)?.parent?.kind != SyntaxKind.InferType)
        throw new Error(`Unknown type parameter ${name}`)
      return {type: name, typeParamSource: found ? found.id : this.id}
    }