// 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 { ApiParameterListMixin, type IApiParameterListMixinOptions } from '../mixins/ApiParameterListMixin'; import { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; import { type IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin'; import { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; import { type IApiTypeParameterListMixinOptions, ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin'; import { ApiOptionalMixin, type IApiOptionalMixinOptions } from '../mixins/ApiOptionalMixin'; /** @public */ export interface IApiMethodSignatureOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiOptionalMixinOptions, IApiDeclaredItemOptions {} /** * Represents a TypeScript member function declaration that belongs to an `ApiInterface`. * * @remarks * * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of * API declarations. * * `ApiMethodSignature` represents a TypeScript declaration such as the `render` member function in this example: * * ```ts * export interface IWidget { * render(): void; * } * ``` * * Compare with {@link ApiMethod}, which represents a method belonging to a class. * For example, a class method can be `static` but an interface method cannot. * * @public */ export class ApiMethodSignature extends ApiNameMixin( ApiTypeParameterListMixin( ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiOptionalMixin(ApiDeclaredItem)))) ) ) { public constructor(options: IApiMethodSignatureOptions) { super(options); } public static getContainerKey(name: string, overloadIndex: number): string { return `${name}|${ApiItemKind.MethodSignature}|${overloadIndex}`; } public override get kind(): ApiItemKind { return ApiItemKind.MethodSignature; } public override get containerKey(): string { return ApiMethodSignature.getContainerKey(this.name, this.overloadIndex); } /** @beta */ public override buildCanonicalReference(): DeclarationReference { const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) .addNavigationStep(Navigation.Members, nameComponent) .withMeaning(Meaning.Member) .withOverloadIndex(this.overloadIndex); } }