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

Support for property access such as Type['prop'] #1335

Closed
bradennapier opened this issue Jul 6, 2020 · 1 comment
Closed

Support for property access such as Type['prop'] #1335

bradennapier opened this issue Jul 6, 2020 · 1 comment
Labels
enhancement Improved functionality

Comments

@bradennapier
Copy link

bradennapier commented Jul 6, 2020

Search Terms

  • property access
  • type properties

Problem

type Example {
   foo: 'bar' | 'baz'
}

/** Documentation generated is just plain text */
function someFunc(v: Example['foo']) {

}

image

Sorry if there is already some other manner which it can be access with. Although that is the typescript-method so I am assuming not :)

Suggested Solution

The TS compiler API should be providing this information, although I am not versed on how the exact configuration is setup for TypeDoc at the moment.

  • MAJOR bonus points if it even grabs the documentation description from that and displays it inline <3

image

@bradennapier bradennapier added the enhancement Improved functionality label Jul 6, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 8, 2020

This looks like a duplicate of #1226 to me.

Pulling in the documentation is really tricky. The TS compiler/language server does a ton of magic behind the scenes to get everything to work. I think it is out of scope for TypeDoc. We don't do this anywhere else, and TypeDoc is already plenty complex without trying to duplicate the language service...

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

No branches or pull requests

2 participants