Skip to content

[api-extractor] Adds support for surfacing whether a class member is protected#3387

Merged
octogonz merged 2 commits intomicrosoft:mainfrom
zelliott:protected-mixin
Jun 7, 2022
Merged

[api-extractor] Adds support for surfacing whether a class member is protected#3387
octogonz merged 2 commits intomicrosoft:mainfrom
zelliott:protected-mixin

Conversation

@zelliott
Copy link
Contributor

@zelliott zelliott commented May 3, 2022

Summary

Fixes #3386.

Details

  • Adds a new ApiProtectedMixin mixin similar to the existing ApiStaticMixin mixin. Applies this mixin to the class constructor, property, and method API items.
  • Updated api-extractor-model to parse whether a class member has the protected modifier.
  • Did not update api-documenter. That is coming in a subsequent PR.

How it was tested

Added some additional test cases to the build tests, ran rush rebuild, manually verified that the .api.json files looked correct.

@iclanton
Copy link
Member

iclanton commented May 4, 2022

This looks good to me. @octogonz - can you take a look as well so we can get this in?

@zelliott zelliott force-pushed the protected-mixin branch from 1f8e836 to 5e08d29 Compare May 5, 2022 15:03
@zelliott zelliott requested a review from octogonz May 5, 2022 15:05
Copy link

@calbearox calbearox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@zelliott
Copy link
Contributor Author

zelliott commented Jun 7, 2022

@octogonz This should be good to merge. The api-documenter changes were pulled out into zelliott#2.

@octogonz octogonz merged commit fd89af2 into microsoft:main Jun 7, 2022
@octogonz
Copy link
Collaborator

octogonz commented Jun 7, 2022

Awesome, thanks @zelliott for implementing this!

Qjuh pushed a commit to discordjs/rushstack that referenced this pull request Nov 7, 2023
[api-extractor] Adds support for surfacing whether a class member is protected
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[api-extractor] Surface whether a class member is protected

4 participants