-
Notifications
You must be signed in to change notification settings - Fork 618
/
Copy pathApiProperty.ts
94 lines (87 loc) · 3.09 KB
/
ApiProperty.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
// 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,
type Component
} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
import { ApiItemKind } from '../items/ApiItem';
import { ApiAbstractMixin, type IApiAbstractMixinOptions } from '../mixins/ApiAbstractMixin';
import { ApiProtectedMixin, type IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin';
import { ApiStaticMixin, type IApiStaticMixinOptions } from '../mixins/ApiStaticMixin';
import { ApiInitializerMixin, type IApiInitializerMixinOptions } from '../mixins/ApiInitializerMixin';
import { ApiPropertyItem, type IApiPropertyItemOptions } from '../items/ApiPropertyItem';
/**
* Constructor options for {@link ApiProperty}.
* @public
*/
export interface IApiPropertyOptions
extends IApiPropertyItemOptions,
IApiAbstractMixinOptions,
IApiProtectedMixinOptions,
IApiStaticMixinOptions,
IApiInitializerMixinOptions {}
/**
* Represents a TypeScript property declaration that belongs to an `ApiClass`.
*
* @remarks
*
* This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
* API declarations.
*
* `ApiProperty` represents a TypeScript declaration such as the `width` and `height` members in this example:
*
* ```ts
* export class Widget {
* public width: number = 100;
*
* public get height(): number {
* if (this.isSquashed()) {
* return 0;
* } else {
* return this.clientArea.height;
* }
* }
* }
* ```
*
* Note that member variables are also considered to be properties.
*
* If the property has both a getter function and setter function, they will be represented by a single `ApiProperty`
* and must have a single documentation comment.
*
* Compare with {@link ApiPropertySignature}, which represents a property belonging to an interface.
* For example, a class property can be `static` but an interface property cannot.
*
* @public
*/
export class ApiProperty extends ApiAbstractMixin(
ApiProtectedMixin(ApiStaticMixin(ApiInitializerMixin(ApiPropertyItem)))
) {
public constructor(options: IApiPropertyOptions) {
super(options);
}
public static getContainerKey(name: string, isStatic: boolean): string {
if (isStatic) {
return `${name}|${ApiItemKind.Property}|static`;
} else {
return `${name}|${ApiItemKind.Property}|instance`;
}
}
/** @override */
public get kind(): ApiItemKind {
return ApiItemKind.Property;
}
/** @override */
public get containerKey(): string {
return ApiProperty.getContainerKey(this.name, this.isStatic);
}
/** @beta @override */
public buildCanonicalReference(): DeclarationReference {
const nameComponent: Component = DeclarationReference.parseComponent(this.name);
return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
.addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent)
.withMeaning(Meaning.Member);
}
}