Class ApiClassPlugin

packages/ts-docs-gen/src/plugins/api-class-plugin.ts:9–86

import { ApiClass } from "../api-items/definitions/api-class";

export class ApiClassPlugin extends ContainerPlugin<Contracts.ApiClassDto> {
    public SupportedApiDefinitionKind(): SupportedApiItemKindType[] {
        return [GeneratorHelpers.ApiDefinitionKind.Class];
    }

    public static readonly MemberKindsList: ContainerMembersKindsGroup[] = [
        {
            Heading: "Index",
            Kinds: [GeneratorHelpers.ApiDefinitionKind.Index]
        },
        {
            Heading: "Constructor",
            Kinds: [GeneratorHelpers.ApiDefinitionKind.ClassConstructor]
        },
        {
            Heading: "Methods",
            Kinds: [GeneratorHelpers.ApiDefinitionKind.ClassMethod]
        },
        {
            Heading: "Properties",
            Kinds: [
                GeneratorHelpers.ApiDefinitionKind.ClassProperty,
                GeneratorHelpers.ApiDefinitionKind.GetAccessor,
                GeneratorHelpers.ApiDefinitionKind.SetAccessor,
            ]
        },
        {
            Heading: "Other",
            Kinds: [
                GeneratorHelpers.ApiDefinitionKind.Any
            ]
        }
    ];

    public Render(options: PluginOptions, apiItem: Contracts.ApiClassDto): PluginResult {
        const serializedApiItem = new ApiClass(options.ExtractedData, apiItem, options.Reference);

        const heading = serializedApiItem.ToHeadingText();
        const pluginResult: PluginResult = {
            ...GeneratorHelpers.GetDefaultPluginResultData(),
            ApiItem: apiItem,
            Reference: options.Reference,
            UsedReferences: [options.Reference.Id]
        };

        // Header
        pluginResult.Result = new MarkdownBuilder()
            .Header(heading, 1)
            .EmptyLine()
            .Text(this.RenderApiItemMetadata(apiItem))
            .Code(serializedApiItem.ToText(), GeneratorHelpers.DEFAULT_CODE_OPTIONS)
            .GetOutput();

        // TypeParameters
        const typeParametersResult = this.RenderTypeParameters(options.ExtractedData, serializedApiItem.TypeParameters);
        GeneratorHelpers.MergePluginResultData(pluginResult, typeParametersResult);

        // ApiMembers