feat(website): add support for type parameter documentation (#8237)

This commit is contained in:
Suneet Tipirneni
2022-07-06 11:37:33 -04:00
committed by GitHub
parent 8198da5cd0
commit 34531c45e3
14 changed files with 145 additions and 12 deletions

View File

@@ -10,6 +10,7 @@ import {
type ApiPropertyItem,
type ExcerptToken,
type Parameter,
type TypeParameter,
} from '@microsoft/api-extractor-model';
import type { DocNode, DocParagraph, DocPlainText } from '@microsoft/tsdoc';
@@ -167,3 +168,22 @@ export function getMembers(pkg: ApiPackage) {
path: generatePath(member.getHierarchy()),
}));
}
export interface TypeParameterData {
name: string;
constraintTokens: TokenDocumentation[];
defaultTokens: TokenDocumentation[];
optional: boolean;
}
export function generateTypeParamData(model: ApiModel, typeParam: TypeParameter): TypeParameterData {
const constraintTokens = typeParam.constraintExcerpt.spannedTokens.map((token) => genToken(model, token));
const defaultTokens = typeParam.defaultTypeExcerpt.spannedTokens.map((token) => genToken(model, token));
return {
name: typeParam.name,
constraintTokens,
defaultTokens,
optional: typeParam.isOptional,
};
}