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

--excludeNotExported excludes export equals #1023

Closed
jerylvaz opened this issue Apr 25, 2019 · 5 comments
Closed

--excludeNotExported excludes export equals #1023

jerylvaz opened this issue Apr 25, 2019 · 5 comments
Labels
bug Functionality does not match expectation

Comments

@jerylvaz
Copy link

Steps to reproduce the bug

src/a.js

/**
 * foo method.
 */
function foo (bar: string): string {
    return bar;
}

/** Some class */
class FooClass {
   constructor () {
      foo('bar');
   }
}

export = FooClass;

tsconfig.json

{
  "compilerOptions": {
    "moduleResolution": "node",
    "module": "commonjs",
    "target": "es2017",
    "esModuleInterop": true,
    "strict": true,
    "noImplicitThis": true,
    "noImplicitAny": true,
    "noUnusedParameters": true,
    "noUnusedLocals": true,
    "inlineSourceMap": true
  },
  "include": [
    "src/**/*"
  ]
}

Command: typedoc --excludeNotExported --out ./doc

FooClass is excluded even though it is exported.

Environment

  • Typedoc version: 0.13.0
  • Node.js version: 8.10.0
  • OS: Ubuntu 18.04
@jerylvaz jerylvaz added the bug Functionality does not match expectation label Apr 25, 2019
@alber70g
Copy link

alber70g commented Jun 5, 2019

I have this issue as well.

This is especially annoying when writing functions with docs and exporting them at the end. E.g.:

/**
 * A bunch of docs about this function
 */
const someFunction = (param1: string) => {
  // some code
}

export const someSetOfFunctions = {
  someFunction, 
  // ... maybe more functions
}

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 6, 2019

I believe that's a different issue, and would require restructuring the converter in order to fix...

#801 should fix the issue with export =, but I'm not sure if it will fix your problem.

@alber70g
Copy link

alber70g commented Jun 6, 2019

@Gerrit0 should I make a new issue for this?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 6, 2019

Yes please, I believe it's a different issue.

@alber70g
Copy link

@Gerrit0 I've made an issue: #1050

@Gerrit0 Gerrit0 added this to To do in Version 0.20 via automation Nov 29, 2020
@Gerrit0 Gerrit0 moved this from To do to Done in Version 0.20 Nov 29, 2020
@Gerrit0 Gerrit0 closed this as completed Dec 28, 2020
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
No open projects
Development

No branches or pull requests

3 participants