Skip to content

Should private members marked by @private be included? #27

Description

@diskdance

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:

  1. A public member's JSDoc may contains link to a private members
  2. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions