utils/node_modules/@microsoft/tsdoc/lib/nodes/DocMemberSymbol.js
2024-02-07 01:33:07 -05:00

87 lines
3.2 KiB
JavaScript

var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
import { DocNodeKind, DocNode } from './DocNode';
import { DocExcerpt, ExcerptKind } from './DocExcerpt';
/**
* Represents a reference to an ECMAScript 6 symbol that is used
* to identify a member declaration.
*
* @example
*
* In the declaration reference `{@link MyClass.([MySymbols.example]:instance)}`,
* the member symbol `[MySymbols.example]` might be used to reference a property
* of the class.
*/
var DocMemberSymbol = /** @class */ (function (_super) {
__extends(DocMemberSymbol, _super);
/**
* Don't call this directly. Instead use {@link TSDocParser}
* @internal
*/
function DocMemberSymbol(parameters) {
var _this = _super.call(this, parameters) || this;
if (DocNode.isParsedParameters(parameters)) {
_this._leftBracketExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.DocMemberSymbol_LeftBracket,
content: parameters.leftBracketExcerpt
});
if (parameters.spacingAfterLeftBracketExcerpt) {
_this._spacingAfterLeftBracketExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.Spacing,
content: parameters.spacingAfterLeftBracketExcerpt
});
}
_this._rightBracketExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.DocMemberSymbol_RightBracket,
content: parameters.rightBracketExcerpt
});
}
_this._symbolReference = parameters.symbolReference;
return _this;
}
Object.defineProperty(DocMemberSymbol.prototype, "kind", {
/** @override */
get: function () {
return DocNodeKind.MemberSymbol;
},
enumerable: false,
configurable: true
});
Object.defineProperty(DocMemberSymbol.prototype, "symbolReference", {
/**
* The declaration reference for the ECMAScript 6 symbol that will act as
* the identifier for the member.
*/
get: function () {
return this._symbolReference;
},
enumerable: false,
configurable: true
});
/** @override */
DocMemberSymbol.prototype.onGetChildNodes = function () {
return [
this._leftBracketExcerpt,
this._spacingAfterLeftBracketExcerpt,
this._symbolReference,
this._rightBracketExcerpt
];
};
return DocMemberSymbol;
}(DocNode));
export { DocMemberSymbol };
//# sourceMappingURL=DocMemberSymbol.js.map