Skip to content

intersection type: T & { … } not fully documented #2276

@bugwelle

Description

@bugwelle

Search terms

intersection type

( I searched for "intersection type" before opening this issue; I found #1519 but that was closed as completed )

Expected Behavior

I would expect intersection types to be documented as well (their fields), i.e. the right-hand-side of typical intersections such as A & { … }.

Actual Behavior

Intersection type is not fully documented.

Steps to reproduce the bug

  • Install typedoc v0.24.7
  • Generate documentation for following snippet
export = project;

declare namespace project {
  /**
   * Options abc.
   */
  export type Options = {
    /**
     * My Flag
     */
    flag?: boolean
  }

  export type OtherOptions = Options & {
    /**
     * other flag
     */
    flag2: string | 'f' | 'g'
  }
}

Open documentation. You will see:

Options:
Screenshot 2023-05-10 at 10 11 23

OtherOptions:

Screenshot 2023-05-10 at 10 11 31

Environment

  • Typedoc version: 0.24.7
  • TypeScript version: Version 5.0.4
  • Node.js version: v18.16.0
  • OS: macOS 13.3.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions