RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor-model > ApiMethodSignature

ApiMethodSignature class

Represents a TypeScript member function declaration that belongs to an ApiInterface.

Signature:

export declare class ApiMethodSignature extends ApiMethodSignature_base 

Extends: ApiMethodSignature_base

Remarks

This is part of the 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:

export interface IWidget {
render(): void;
}

Compare with ApiMethod, which represents a method belonging to a class. For example, a class method can be static but an interface method cannot.

(Some inherited members may not be shown because they are not represented in the documentation.)

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the ApiMethodSignature class

Properties

PropertyModifiersTypeDescription
containerKeyreadonlystring
kindreadonlyApiItemKind

Methods

MethodModifiersDescription
buildCanonicalReference()(BETA)
getContainerKey(name, overloadIndex)static