| System: Linux srv913213 5.15.0-190-generic #200-Ubuntu SMP Fri Aug 7 15:06:04 UTC 2026 x86_64 Current Path : /var/www/talentgenesis_admin_backend/node_modules/@microsoft/tsdoc/lib/nodes/ |
| Current File : /var/www/talentgenesis_admin_backend/node_modules/@microsoft/tsdoc/lib/nodes/DocParamBlock.js |
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
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 (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
import { DocNodeKind, DocNode } from './DocNode';
import { DocBlock } from './DocBlock';
import { DocExcerpt, ExcerptKind } from './DocExcerpt';
/**
* Represents a parsed `@param` or `@typeParam` block, which provides a description for a
* function parameter.
*/
var DocParamBlock = /** @class */ (function (_super) {
__extends(DocParamBlock, _super);
/**
* Don't call this directly. Instead use {@link TSDocParser}
* @internal
*/
function DocParamBlock(parameters) {
var _this = _super.call(this, parameters) || this;
_this._parameterName = parameters.parameterName;
if (DocNode.isParsedParameters(parameters)) {
if (parameters.spacingBeforeParameterNameExcerpt) {
_this._spacingBeforeParameterNameExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.Spacing,
content: parameters.spacingBeforeParameterNameExcerpt
});
}
if (parameters.unsupportedJsdocTypeBeforeParameterNameExcerpt) {
_this._unsupportedJsdocTypeBeforeParameterNameExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.NonstandardText,
content: parameters.unsupportedJsdocTypeBeforeParameterNameExcerpt
});
}
if (parameters.unsupportedJsdocOptionalNameOpenBracketExcerpt) {
_this._unsupportedJsdocOptionalNameOpenBracketExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.NonstandardText,
content: parameters.unsupportedJsdocOptionalNameOpenBracketExcerpt
});
}
_this._parameterNameExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.ParamBlock_ParameterName,
content: parameters.parameterNameExcerpt
});
if (parameters.unsupportedJsdocOptionalNameRestExcerpt) {
_this._unsupportedJsdocOptionalNameRestExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.NonstandardText,
content: parameters.unsupportedJsdocOptionalNameRestExcerpt
});
}
if (parameters.spacingAfterParameterNameExcerpt) {
_this._spacingAfterParameterNameExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.Spacing,
content: parameters.spacingAfterParameterNameExcerpt
});
}
if (parameters.unsupportedJsdocTypeAfterParameterNameExcerpt) {
_this._unsupportedJsdocTypeAfterParameterNameExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.NonstandardText,
content: parameters.unsupportedJsdocTypeAfterParameterNameExcerpt
});
}
if (parameters.hyphenExcerpt) {
_this._hyphenExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.ParamBlock_Hyphen,
content: parameters.hyphenExcerpt
});
}
if (parameters.spacingAfterHyphenExcerpt) {
_this._spacingAfterHyphenExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.Spacing,
content: parameters.spacingAfterHyphenExcerpt
});
}
if (parameters.unsupportedJsdocTypeAfterHyphenExcerpt) {
_this._unsupportedJsdocTypeAfterHyphenExcerpt = new DocExcerpt({
configuration: _this.configuration,
excerptKind: ExcerptKind.NonstandardText,
content: parameters.unsupportedJsdocTypeAfterHyphenExcerpt
});
}
}
return _this;
}
Object.defineProperty(DocParamBlock.prototype, "kind", {
/** @override */
get: function () {
return DocNodeKind.ParamBlock;
},
enumerable: false,
configurable: true
});
Object.defineProperty(DocParamBlock.prototype, "parameterName", {
/**
* The name of the parameter that is being documented.
* For example "width" in `@param width - the width of the object`.
*/
get: function () {
return this._parameterName;
},
enumerable: false,
configurable: true
});
/** @override */
DocParamBlock.prototype.onGetChildNodes = function () {
return [
this.blockTag,
this._spacingBeforeParameterNameExcerpt,
this._unsupportedJsdocTypeBeforeParameterNameExcerpt,
this._unsupportedJsdocOptionalNameOpenBracketExcerpt,
this._parameterNameExcerpt,
this._unsupportedJsdocOptionalNameRestExcerpt,
this._spacingAfterParameterNameExcerpt,
this._unsupportedJsdocTypeAfterParameterNameExcerpt,
this._hyphenExcerpt,
this._spacingAfterHyphenExcerpt,
this._unsupportedJsdocTypeAfterHyphenExcerpt,
this.content
];
};
return DocParamBlock;
}(DocBlock));
export { DocParamBlock };
//# sourceMappingURL=DocParamBlock.js.map