// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. import { DeclarationReference, Meaning, Navigation, type Component } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, type IApiDeclaredItemOptions } from '../items/ApiDeclaredItem'; import { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; import { ApiItemContainerMixin, type IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; import type { ApiEnumMember } from './ApiEnumMember'; import { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; import { type IApiExportedMixinOptions, ApiExportedMixin } from '../mixins/ApiExportedMixin'; /** * Constructor options for {@link ApiEnum}. * @public */ export interface IApiEnumOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions, IApiExportedMixinOptions {} /** * Represents a TypeScript enum declaration. * * @remarks * * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of * API declarations. * * `ApiEnum` represents an enum declaration such as `FontSizes` in the example below: * * ```ts * export enum FontSizes { * Small = 100, * Medium = 200, * Large = 300 * } * ``` * * @public */ export class ApiEnum extends ApiItemContainerMixin( ApiNameMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem))) ) { public constructor(options: IApiEnumOptions) { super(options); } public static getContainerKey(name: string): string { return `${name}|${ApiItemKind.Enum}`; } public override get kind(): ApiItemKind { return ApiItemKind.Enum; } public override get members(): ReadonlyArray { return super.members as ReadonlyArray; } public override get containerKey(): string { return ApiEnum.getContainerKey(this.name); } public override addMember(member: ApiEnumMember): void { if (member.kind !== ApiItemKind.EnumMember) { throw new Error('Only ApiEnumMember objects can be added to an ApiEnum'); } super.addMember(member); } /** @beta */ public override buildCanonicalReference(): DeclarationReference { const nameComponent: Component = DeclarationReference.parseComponent(this.name); const navigation: Navigation = this.isExported ? Navigation.Exports : Navigation.Locals; return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) .addNavigationStep(navigation, nameComponent) .withMeaning(Meaning.Enum); } }