RoadmapShopEvents
Skip to main content

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

ApiCallSignature class

Represents a TypeScript function call signature.

Signature:
export declare class ApiCallSignature extends ApiCallSignature_base
Extends: ApiCallSignature_base

Remarks

This is part of the ApiModel hierarchy of classes, which are serializable representations of API declarations.

ApiCallSignature represents a TypeScript declaration such as (x: number, y: number): number in this example:

export interface IChooser {
// A call signature:
(x: number, y: number): number;

// Another overload for this call signature:
(x: string, y: string): string;
}

function chooseFirst<T>(x: T, y: T): T {
return x;
}

let chooser: IChooser = chooseFirst;

Constructors

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

Properties

PropertyModifiersTypeDescription
containerKeystring
kindApiItemKind

Methods

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