55 lines
2.2 KiB
TypeScript
55 lines
2.2 KiB
TypeScript
import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
|
|
import { ApiItemKind } from '../items/ApiItem';
|
|
import { type IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';
|
|
import { type IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
|
|
import { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
|
|
import { type IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';
|
|
import { type IApiTypeParameterListMixinOptions, ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
|
|
/**
|
|
* Constructor options for {@link ApiCallSignature}.
|
|
* @public
|
|
*/
|
|
export interface IApiCallSignatureOptions extends IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions {
|
|
}
|
|
declare const ApiCallSignature_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiReturnTypeMixin) & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiParameterListMixin) & (new (...args: any[]) => ApiTypeParameterListMixin);
|
|
/**
|
|
* Represents a TypeScript function call signature.
|
|
*
|
|
* @remarks
|
|
*
|
|
* This is part of the {@link 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:
|
|
*
|
|
* ```ts
|
|
* 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;
|
|
* ```
|
|
*
|
|
* @public
|
|
*/
|
|
export declare class ApiCallSignature extends ApiCallSignature_base {
|
|
constructor(options: IApiCallSignatureOptions);
|
|
static getContainerKey(overloadIndex: number): string;
|
|
/** @override */
|
|
get kind(): ApiItemKind;
|
|
/** @override */
|
|
get containerKey(): string;
|
|
/** @beta @override */
|
|
buildCanonicalReference(): DeclarationReference;
|
|
}
|
|
export {};
|
|
//# sourceMappingURL=ApiCallSignature.d.ts.map
|