Non-exported referenced types

[Azario16]

          @Gerrit0 Good afternoon

I agree with you that there is no point in describing variables that are not exported

But what about the interfaces that are exported and inside which there are parameters from the same directory and they are not exported but are used inside the exported interface

How will a person who opens the documentation understand what exactly needs to be put in the required parameter?

Example:

export interface User {
    detail: Detail
}

interface Detail {
    name: string;
    age: number
}

Originally posted by @Azario16 in #1521 (comment)

[Gerrit0]

Detail should be exported. By not exporting it, you're making your API distinctly worse by requiring that if I'm building up an object for your API iteratively I either have to extract the type myself:

const det: User["detail"] = { ... }

const user: User = { detail: det }

Or live without excess property checks while building that object up.

const det = {
  name: "x",
  age: 123,
  married: false
}

const x: User = { detail: det } // NO errors!

However, I've gotten sufficiently tired of arguing with people about this, so typedoc-plugin-missing-exports exists, and will automatically create documentation for non-exported "exports" and stick them in an <internals> namespace.

[Azario16]

Yes, you're right, it's really logical and makes sense.
Thanks for the answer and experience