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

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.

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the `ApiMethodSignature` class

Property	Modifiers	Type	Description
containerKey	`readonly`	string
kind	`readonly`	ApiItemKind

Method	Modifiers	Description
buildCanonicalReference()		*(BETA)*
getContainerKey(name, overloadIndex)	`static`