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

Unable to hide default export with @internal #1903

Closed
glensc opened this issue Apr 1, 2022 · 1 comment
Closed

Unable to hide default export with @internal #1903

glensc opened this issue Apr 1, 2022 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@glensc
Copy link

glensc commented Apr 1, 2022

Search terms

@internal, excludeInternal

Expected Behavior

Marking @internal to default export should be omitted from documentation

Actual Behavior

The default export is still included in output

image

Steps to reproduce

// src/index.ts
/**
 * @deprecated Use Logger.create
 * @internal
 */
export default (options: LoggerOptions = {}) => {
  return LegacyLogger.create(options);
}
$ typedoc  --excludeInternal

Environment

  • Typedoc version: 0.22.13
  • TypeScript version: 4.6.2
  • Node.js version: v14.19.1
  • OS: Irrelevant (macOS)
@glensc glensc added the bug Functionality does not match expectation label Apr 1, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 3, 2022

Huh, this is specific to using a default exported arrow function. Regular functions work fine, arrow functions non-default exported are fine...

@Gerrit0 Gerrit0 closed this as completed in 45beb25 Apr 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants