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

[FEATURE]: Support exported types in the documentation coverage #1419

Open
stijnbollen opened this issue Dec 4, 2023 · 0 comments
Open

[FEATURE]: Support exported types in the documentation coverage #1419

stijnbollen opened this issue Dec 4, 2023 · 0 comments
Assignees

Comments

@stijnbollen
Copy link

Overview of the feature

Documentation for declarations that start with export type should be added to the site's documentation coverage page.

Motivation for or Use Case

In my project I have several exported types that mutate both internal and external interfaces.
Because my colleagues should use these mutated interfaces instead of the ones they are based upon,
it is important that these types are properly documented.
The easiest way to validate the coverage of these exported types would be to have them listed in the same place as the classes, components and interfaces.

Examples of these exported types in my project are:

  • Mutation of an external interface
/**
 * CSS Style Declaration object with optional properties (as it should be)
 */
export type CSSStyleObject = Partial<CSSStyleDeclaration>;
  • Mutation of an internal interface
/**
 * Defines the font properties of a text, extends all properties with the currentable property flags
 */
export type ICurrentableFontDefinition = {
    [prop in keyof FontDefinition]: ICurrentableProperty<FontDefinition[prop]>;
};

Currently these types are added to the documentation, but not to the coverage page.

Related issues

Support exported type

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants