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

Don't show superfluous undefined in optional properties #1525

Labels
bug Functionality does not match expectation

Comments

@marcofugaro
Copy link

marcofugaro commented Mar 4, 2021

Search terms

undefined optional parameter

Actual Behavior

After upgrading Typedoc to the latest version (this happens on 0.20.6 and up), Typedoc is showing the undefined value also for parameters which are already marked as optional with ?. This makes the parameters section much more clustered and difficult to read:

image

Expected Behavior

I would like an option to disable this behaviour, and make it look like it was originally (this is version 0.20.1):

image

Environment

  • Typedoc version: 0.20.6 and up
@marcofugaro marcofugaro added the bug Functionality does not match expectation label Mar 4, 2021
@Gerrit0 Gerrit0 changed the title Don't show superfluous undefined in optional parameters Don't show superfluous undefined in optional properties Mar 5, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 5, 2021

This is behaving as expected for parameters but not for properties (note how options doesn't have a | undefined)

@Gerrit0 Gerrit0 closed this as completed in c9faa9b Mar 6, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 6, 2021

Fixed in 0.20.30

This was referenced Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment