Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full local paths included when inheriting from Node types #800

Closed
jameswilddev opened this issue Jun 19, 2018 · 7 comments
Closed

Full local paths included when inheriting from Node types #800

jameswilddev opened this issue Jun 19, 2018 · 7 comments

Comments

@jameswilddev
Copy link

Define the following types:

/**
 * Defines types which can be round-tripped by `JSON.parse` and
 * `JSON.stringify`.
 */
export type Json = string | number | boolean | JsonObject | JsonArray | null;

/**
 * This is a helper type required by [[Json]].
 */
export interface JsonObject {
  /**
   * The properties defined.
   */
  readonly [x: string]: Json;
}

/**
 * This is a helper type required by [[Json]].
 */
export interface JsonArray extends ReadonlyArray<Json> { }

The documentation for JsonArray will include everything defined in ReadonlyArray (this is correct), with the full path to the user's local install of TypeScript (this is not expected), as below:

c

This may have been reported previously in #169 but whether this is the same problem is not clear.

@notwaldorf
Copy link

@jameswilddev have you found a workaround for this yet, by any chance? I can repro this with classes that extend Error to, eg:

export class SomeException extends Error {
  ...
}

@jameswilddev
Copy link
Author

I've not been using TypeDoc; like the idea but it doesn't support a lot of the TypeScript features I use often. I believe TypeScript's developers are doing something in-house.

@chapterjason
Copy link

chapterjason commented Oct 9, 2018

Facing the same issue... 😞 Shouldn't the excludeExternals exclude these references? Wouldn't be better to place there something like (if I take your example above) typescript/lib/lib.d.ts:1002. Specify an external map would also be great. Something to reference to the other documentation.

@DanTheMan827
Copy link

DanTheMan827 commented Feb 8, 2019

it's not just node types but others too

Inherited from Error.message

Defined in X:/Users/Daniel/Documents/GitHub/node-fel/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964

@b4nst
Copy link

b4nst commented Apr 12, 2019

Any news on that issue ? Facing the same problem here

@psichma
Copy link

psichma commented May 7, 2019

Yup, I'm also getting this problem. Tried every kind of combination of the exclude parameters, but nothing seems to work.
For me its not the inheritance of typescript specific stuff, but in general of other node modules.
I really don't want to release a documentation with my local paths.

Gerrit0 added a commit that referenced this issue Nov 13, 2019
Incidentally, this also:
Fixes #800
Fixes #642

Removes ts-node since this fix results in tests breaking when run through ts-node.

And because I needed to rebuild tests, pulls in the refactoring for rebuild_specs.js from #801
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 13, 2019

Closing this in favor of #642, will be fixed in the next version anyways.

@Gerrit0 Gerrit0 closed this as completed Nov 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants