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

On private members and overrides #9

Closed
dcodeIO opened this issue Nov 10, 2016 · 3 comments
Closed

On private members and overrides #9

dcodeIO opened this issue Nov 10, 2016 · 3 comments

Comments

@dcodeIO
Copy link

dcodeIO commented Nov 10, 2016

I have a config here that reads

{
    "tags": {
        "allowUnknownTags": false
    },
    "source": {
        "include": [
            "./src/"
        ],
        "exclude": [],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "opts": {
        "encoding"      : "utf8",
        "recurse"       : true,
        "private"       : false,
        "lenient"       : true,
        "destination"   : "./types",
        "template"      : "./node_modules/tsd-jsdoc"
    }
}

When I run this with tsd-jsdoc, it generates definitions for private members with a leading _, which will, on a production build, be renamed to something random. Is there another way to exclude them?

Also, when I /** @override */ a method with a different signature, the overridden signature seems not to be included in the output. Let's say I have a Reader that works with array-like objects and a BufferReader that partly requires a proper buffer, then this would be valuable information for a type checker.

@englercj
Copy link
Owner

Thanks for the report, after I finish my proto -> ts stuff I'll hope back onto my write here and ensure this gets fixed.

@englercj
Copy link
Owner

englercj commented Feb 6, 2017

Got this fixed in v2, unfortunately there are some jsdoc bugs that make this not work 100%:

@englercj englercj closed this as completed Feb 6, 2017
@englercj
Copy link
Owner

Just released v2.0.0-beta.1, there are still bugs (the issues I opened) but please feel free to try it out and file more bugs!

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

2 participants