UNPKG

3.5 kBJavaScriptView Raw
1"use strict";
2var __extends = (this && this.__extends) || (function () {
3 var extendStatics = function (d, b) {
4 extendStatics = Object.setPrototypeOf ||
5 ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6 function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
7 return extendStatics(d, b);
8 };
9 return function (d, b) {
10 extendStatics(d, b);
11 function __() { this.constructor = d; }
12 d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
13 };
14})();
15Object.defineProperty(exports, "__esModule", { value: true });
16exports.DocMemberSymbol = void 0;
17var DocNode_1 = require("./DocNode");
18var DocExcerpt_1 = require("./DocExcerpt");
19/**
20 * Represents a reference to an ECMAScript 6 symbol that is used
21 * to identify a member declaration.
22 *
23 * @example
24 *
25 * In the declaration reference `{@link MyClass.([MySymbols.example]:instance)}`,
26 * the member symbol `[MySymbols.example]` might be used to reference a property
27 * of the class.
28 */
29var DocMemberSymbol = /** @class */ (function (_super) {
30 __extends(DocMemberSymbol, _super);
31 /**
32 * Don't call this directly. Instead use {@link TSDocParser}
33 * @internal
34 */
35 function DocMemberSymbol(parameters) {
36 var _this = _super.call(this, parameters) || this;
37 if (DocNode_1.DocNode.isParsedParameters(parameters)) {
38 _this._leftBracketExcerpt = new DocExcerpt_1.DocExcerpt({
39 configuration: _this.configuration,
40 excerptKind: DocExcerpt_1.ExcerptKind.DocMemberSymbol_LeftBracket,
41 content: parameters.leftBracketExcerpt
42 });
43 if (parameters.spacingAfterLeftBracketExcerpt) {
44 _this._spacingAfterLeftBracketExcerpt = new DocExcerpt_1.DocExcerpt({
45 configuration: _this.configuration,
46 excerptKind: DocExcerpt_1.ExcerptKind.Spacing,
47 content: parameters.spacingAfterLeftBracketExcerpt
48 });
49 }
50 _this._rightBracketExcerpt = new DocExcerpt_1.DocExcerpt({
51 configuration: _this.configuration,
52 excerptKind: DocExcerpt_1.ExcerptKind.DocMemberSymbol_RightBracket,
53 content: parameters.rightBracketExcerpt
54 });
55 }
56 _this._symbolReference = parameters.symbolReference;
57 return _this;
58 }
59 Object.defineProperty(DocMemberSymbol.prototype, "kind", {
60 /** @override */
61 get: function () {
62 return DocNode_1.DocNodeKind.MemberSymbol;
63 },
64 enumerable: false,
65 configurable: true
66 });
67 Object.defineProperty(DocMemberSymbol.prototype, "symbolReference", {
68 /**
69 * The declaration reference for the ECMAScript 6 symbol that will act as
70 * the identifier for the member.
71 */
72 get: function () {
73 return this._symbolReference;
74 },
75 enumerable: false,
76 configurable: true
77 });
78 /** @override */
79 DocMemberSymbol.prototype.onGetChildNodes = function () {
80 return [
81 this._leftBracketExcerpt,
82 this._spacingAfterLeftBracketExcerpt,
83 this._symbolReference,
84 this._rightBracketExcerpt
85 ];
86 };
87 return DocMemberSymbol;
88}(DocNode_1.DocNode));
89exports.DocMemberSymbol = DocMemberSymbol;
90//# sourceMappingURL=DocMemberSymbol.js.map
\No newline at end of file