76 行
2.7 KiB
JavaScript
76 行
2.7 KiB
JavaScript
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
||
|
|
// See LICENSE in the project root for license information.
|
||
|
|
import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
|
||
|
|
import { ApiItemKind } from '../items/ApiItem';
|
||
|
|
import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
|
||
|
|
import { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
|
||
|
|
import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
|
||
|
|
import { ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';
|
||
|
|
import { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
|
||
|
|
/**
|
||
|
|
* Represents a TypeScript construct signature that belongs to an `ApiInterface`.
|
||
|
|
*
|
||
|
|
* @remarks
|
||
|
|
*
|
||
|
|
* This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
|
||
|
|
* API declarations.
|
||
|
|
*
|
||
|
|
* `ApiConstructSignature` represents a construct signature using the `new` keyword such as in this example:
|
||
|
|
*
|
||
|
|
* ```ts
|
||
|
|
* export interface IVector {
|
||
|
|
* x: number;
|
||
|
|
* y: number;
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* export interface IVectorConstructor {
|
||
|
|
* // A construct signature:
|
||
|
|
* new(x: number, y: number): IVector;
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* export function createVector(vectorConstructor: IVectorConstructor,
|
||
|
|
* x: number, y: number): IVector {
|
||
|
|
* return new vectorConstructor(x, y);
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* class Vector implements IVector {
|
||
|
|
* public x: number;
|
||
|
|
* public y: number;
|
||
|
|
* public constructor(x: number, y: number) {
|
||
|
|
* this.x = x;
|
||
|
|
* this.y = y;
|
||
|
|
* }
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* let vector: Vector = createVector(Vector, 1, 2);
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* Compare with {@link ApiConstructor}, which describes the class constructor itself.
|
||
|
|
*
|
||
|
|
* @public
|
||
|
|
*/
|
||
|
|
export class ApiConstructSignature extends ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem)))) {
|
||
|
|
constructor(options) {
|
||
|
|
super(options);
|
||
|
|
}
|
||
|
|
static getContainerKey(overloadIndex) {
|
||
|
|
return `|${ApiItemKind.ConstructSignature}|${overloadIndex}`;
|
||
|
|
}
|
||
|
|
/** @override */
|
||
|
|
get kind() {
|
||
|
|
return ApiItemKind.ConstructSignature;
|
||
|
|
}
|
||
|
|
/** @override */
|
||
|
|
get containerKey() {
|
||
|
|
return ApiConstructSignature.getContainerKey(this.overloadIndex);
|
||
|
|
}
|
||
|
|
/** @beta @override */
|
||
|
|
buildCanonicalReference() {
|
||
|
|
const parent = this.parent
|
||
|
|
? this.parent.canonicalReference
|
||
|
|
: // .withMeaning() requires some kind of component
|
||
|
|
DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');
|
||
|
|
return parent.withMeaning(Meaning.ConstructSignature).withOverloadIndex(this.overloadIndex);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=ApiConstructSignature.js.map
|
