Should private members marked by @private be included?
Opened this issue · 1 comments
diskdance commented
TypeScript only supports private members in ES classes, so for @private
(and @ignore
) members in objects we can either include them in .d.ts with a warning, or not include them at all. I am (mostly) supportive of option 2, but it also has several problems:
- A public member's JSDoc may contains link to a private members
- For users TS throws an error that "this member does not exist" instead of "it is private"
I believe this is a design decision, so discussion is required. cc @AnYiEE
diskdance commented
And should we distinguish between private classes like mw.Map
and private members of objects?