Skip to content

Commit

Permalink
Don't strip out @alpha items from report
Browse files Browse the repository at this point in the history
It is useful for `@alpha` items to appear in metadata and generated documentation. The system currently unconditionally strips all `@alpha` items out.

I don't know how important it is to preserve existing behavior. If so, perhaps this should be configurable somehow? Any feedback / suggestions would be appreciated.
  • Loading branch information
Josmithr authored Sep 14, 2023
1 parent 3ab024c commit aa81d5d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions apps/api-extractor/src/generators/ApiModelGenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ export class ApiModelGenerator {

const apiItemMetadata: ApiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
const releaseTag: ReleaseTag = apiItemMetadata.effectiveReleaseTag;
if (releaseTag === ReleaseTag.Internal || releaseTag === ReleaseTag.Alpha) {
return; // trim out items marked as "@internal" or "@alpha"
if (releaseTag === ReleaseTag.Internal) {
return; // trim out items marked as "@internal"
}

switch (astDeclaration.declaration.kind) {
Expand Down

0 comments on commit aa81d5d

Please sign in to comment.