Home > @microsoft/api-extractor-model > ApiMethod
ApiMethod class
Represents a TypeScript member function declaration that belongs to an ApiClass.
Signature:
export declare class ApiMethod extends ApiMethod_base
Extends: ApiMethod_base
Remarks
This is part of the ApiModel hierarchy of classes, which are serializable representations of API declarations.
ApiMethod represents a TypeScript declaration such as the render member function in this example:
export class Widget {
public render(): void { }
}
Compare with ApiMethodSignature, which represents a method belonging to an interface. For example, a class method can be static but an interface method cannot.
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | Constructs a new instance of the ApiMethod class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| containerKey | readonly | string | |
| kind | readonly | ApiItemKind |
Methods
| Method | Modifiers | Description |
|---|---|---|
| buildCanonicalReference() | (BETA) | |
| getContainerKey(name, isStatic, overloadIndex) | static |