@microsoft/tsdoc

property blockTag

readonly blockTag: DocBlockTag;

• The TSDoc tag that introduces this section.

property content

readonly content: DocSection;

• The TSDoc tag that introduces this section.

property kind

readonly kind: string;

• Modifiers

  • @override

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property kind

readonly kind: string;

• Modifiers

  • @override

property tagName

readonly tagName: string;

• The TSDoc tag name. TSDoc tag names start with an at-sign (@) followed by ASCII letters using "camelCase" capitalization.

property tagNameWithUpperCase

readonly tagNameWithUpperCase: string;

• The TSDoc tag name in all capitals, which is used for performing case-insensitive comparisons or lookups.

method getTokenSequence

getTokenSequence: () => TokenSequence;

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property code

readonly code: string;

• The text that should be rendered as code, excluding the backtick delimiters.

property kind

readonly kind: string;

• Modifiers

  • @override

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property customBlocks

readonly customBlocks: readonly DocBlock[];

• The collection of all DocBlock nodes belonging to this doc comment.

property deprecatedBlock

deprecatedBlock: DocBlock;

• If present, this block indicates that an API item is no loner supported and may be removed in a future release. The @deprecated tag must be followed by a sentence describing the recommended alternative. Deprecation recursively applies to members of a container. For example, if a class is deprecated, then so are all of its members.

property inheritDocTag

inheritDocTag: DocInheritDocTag;

• If this doc comment contains an @inheritDoc tag, it will be extracted and associated with the DocComment.

property kind

readonly kind: string;

• Modifiers

  • @override

property modifierTagSet

readonly modifierTagSet: StandardModifierTagSet;

• The modifier tags for this DocComment.

property params

readonly params: DocParamCollection;

• The collection of parsed @param blocks for this doc comment.

property privateRemarks

privateRemarks: DocBlock;

• The @privateRemarks tag starts a block of additional commentary that is not meant for an external audience. A documentation tool must omit this content from an API reference web site. It should also be omitted when generating a normalized *.d.ts file intended for third-party developers.

  Remarks

  A similar effect could be accomplished by enclosing content inside CommonMark <!-- --> comments, or by moving the content into a separate // TypeScript comment. However, the @privateRemarks tag is a more formal convention.

property remarksBlock

remarksBlock: DocBlock;

• The main documentation for an API item is separated into a brief "summary" section optionally followed by an @remarks block containing additional details.

  Remarks

  Unlike the summary, the remarks block may contain lengthy documentation content. The remarks should not restate information from the summary, since the summary section will always be displayed wherever the remarks section appears. Other sections (e.g. an @example block) will be shown after the remarks section.

property returnsBlock

returnsBlock: DocBlock;

• The @returns block for this doc comment, or undefined if there is not one.

property seeBlocks

readonly seeBlocks: readonly DocBlock[];

• The collection of all @see DockBlockTag nodes belonging to this doc comment.

property summarySection

summarySection: DocSection;

• The main documentation for an API item is separated into a brief "summary" section, optionally followed by an @remarks block containing additional details.

  Remarks

  The summary section should be brief. On a documentation web site, it will be shown on a page that lists summaries for many different API items. On a detail page for a single item, the summary will be shown followed by the remarks section (if any).

property typeParams

readonly typeParams: DocParamCollection;

• The collection of parsed @typeParam blocks for this doc comment.

method appendCustomBlock

appendCustomBlock: (block: DocBlock) => void;

• Append an item to the customBlocks collection.

method emitAsTsdoc

emitAsTsdoc: () => string;

• Generates a doc comment corresponding to the DocComment tree. The output is in a normalized form, and may ignore formatting/spacing from the original input.

  Remarks

  After parsing a string, and possibly modifying the result, emitAsTsdoc() can be used to render the result as a doc comment in a normalized format. It can also be used to emit a DocComment tree that was constructed manually.

  This method is provided as convenience for simple use cases. To customize the output, or if you need to render into a StringBuilder, use the TSDocEmitter class instead.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property importPath

readonly importPath: string;

• The optional import path. If a package name is provided, then if an import path is provided, the path must start with a "/" delimiter; otherwise paths are resolved relative to the source file containing the reference.

  Example: "/path1/path2" Example: "./path1/path2" Example: "../path2/path2"

property kind

readonly kind: string;

• Modifiers

  • @override

property memberReferences

readonly memberReferences: readonly DocMemberReference[];

• The chain of member references that indicate the declaration being referenced. If this list is empty, then either the packageName or importPath must be provided, because the reference refers to a module.

property packageName

readonly packageName: string;

• The optional package name, which may optionally include an NPM scope.

  Example: "@scope/my-package"

method emitAsTsdoc

emitAsTsdoc: () => string;

• Generates the TSDoc representation of this declaration reference.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property errorLocation

readonly errorLocation: TokenSequence;

• The range of characters that caused the error. In general these may be somewhat farther ahead in the input stream from the DocErrorText node itself.

  Remarks

  For example, for the malformed HTML tag <a href="123" @ /a>, the DocErrorText node will correspond to the < character that looked like an HTML tag, whereas the error location might be the @ character that caused the trouble.

property errorMessage

readonly errorMessage: string;

• A description of why the character could not be parsed.

property kind

readonly kind: string;

• Modifiers

  • @override

property messageId

readonly messageId: TSDocMessageId;

• The TSDoc error message identifier.

property text

readonly text: string;

• The characters that should be rendered as plain text because they could not be parsed successfully.

property textExcerpt

readonly textExcerpt: TokenSequence;

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property decodedText

readonly decodedText: string;

• The text without escaping.

property encodedText

readonly encodedText: string;

• The text sequence including escapes.

property escapeStyle

readonly escapeStyle: number;

• The style of escaping to be performed.

property kind

readonly kind: string;

• Modifiers

  • @override

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property content

readonly content: TokenSequence;

• The input token sequence corresponding to this excerpt.

  Remarks

  Note that a token sequence can span multiple input lines and may contain gaps, for example to skip the * character that starts a new TSDoc comment line.

property excerptKind

readonly excerptKind: ExcerptKind;

• Indicates the kind of DocExcerpt.

property kind

readonly kind: string;

• Modifiers

  • @override

property code

readonly code: string;

• The text that should be rendered as code.

property kind

readonly kind: string;

• Modifiers

  • @override

property language

readonly language: string;

• A name that can optionally be included after the opening code fence delimiter, on the same line as the three backticks. This name indicates the programming language for the code, which a syntax highlighter may use to style the code block.

  Remarks

  The TSDoc standard requires that the language "ts" should be interpreted to mean TypeScript. Other languages names may be supported, but this is implementation dependent.

  CommonMark refers to this field as the "info string".

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property kind

readonly kind: string;

• Modifiers

  • @override

property name

readonly name: string;

• The HTML attribute name.

property spacingAfterEquals

readonly spacingAfterEquals: string;

• Explicit whitespace that a renderer should insert after the "=". If undefined, then the renderer can use a formatting rule to generate appropriate spacing.

property spacingAfterName

readonly spacingAfterName: string;

• Explicit whitespace that a renderer should insert after the HTML attribute name. If undefined, then the renderer can use a formatting rule to generate appropriate spacing.

property spacingAfterValue

readonly spacingAfterValue: string;

• Explicit whitespace that a renderer should insert after the HTML attribute name. If undefined, then the renderer can use a formatting rule to generate appropriate spacing.

property value

readonly value: string;

• The HTML attribute value.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property kind

readonly kind: string;

• Modifiers

  • @override

property name

readonly name: string;

• The HTML element name.

method emitAsHtml

emitAsHtml: () => string;

• Generates the HTML for this tag.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property htmlAttributes

readonly htmlAttributes: readonly DocHtmlAttribute[];

• The HTML attributes belonging to this HTML element.

property kind

readonly kind: string;

• Modifiers

  • @override

property name

readonly name: string;

• The HTML element name.

property selfClosingTag

readonly selfClosingTag: boolean;

• If true, then the HTML tag ends with /> instead of >.

property spacingAfterName

readonly spacingAfterName: string;

• Explicit whitespace that a renderer should insert after the HTML element name. If undefined, then the renderer can use a formatting rule to generate appropriate spacing.

method emitAsHtml

emitAsHtml: () => string;

• Generates the HTML for this tag.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property declarationReference

readonly declarationReference: DocDeclarationReference;

• The declaration that the documentation will be inherited from. If omitted, the documentation will be inherited from the parent class.

property kind

readonly kind: string;

• Modifiers

  • @override

method getChildNodesForContent

protected getChildNodesForContent: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property kind

readonly kind: string;

• Modifiers

  • @override

property tagContent

readonly tagContent: string;

• The tag content.

  Remarks

  For example, if the tag is {@myTag x=12.34 y=56.78 } then the tag content would be x=12.34 y=56.78 , including the trailing space but not the leading space.

method getChildNodesForContent

protected getChildNodesForContent: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property tagName

readonly tagName: string;

• The TSDoc tag name. TSDoc tag names start with an at-sign (@) followed by ASCII letters using "camelCase" capitalization.

  Remarks

  For example, if the inline tag is {@link Guid.toString | the toString() method} then the tag name would be @link.

property tagNameWithUpperCase

readonly tagNameWithUpperCase: string;

• The TSDoc tag name in all capitals, which is used for performing case-insensitive comparisons or lookups.

method getChildNodesForContent

protected abstract getChildNodesForContent: () => ReadonlyArray<
    DocNode | undefined
>;

• Allows child classes to replace the tagContentParticle with a more detailed set of nodes.

  Modifiers

  • @virtual

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override
  • @sealed

property codeDestination

readonly codeDestination: DocDeclarationReference;

• If the link tag refers to a declaration, this returns the declaration reference object; otherwise this property is undefined.

  Remarks

  Either the codeDestination or the urlDestination property will be defined, but never both.

property kind

readonly kind: string;

• Modifiers

  • @override

property linkText

readonly linkText: string;

• An optional text string that is the hyperlink text. If omitted, the documentation renderer will use a default string based on the link itself (e.g. the URL text or the declaration identifier).

  Remarks

  In HTML, the hyperlink can include leading/trailing space characters around the link text. For example, this HTML will cause a web browser to y and also the space character before and after it:

  x<a href="#Button"> y </a> z

  Unlike HTML, TSDoc trims leading/trailing spaces. For example, this TSDoc will be displayed xy z and underline only the y character:

  x{@link Button | y } z

property urlDestination

readonly urlDestination: string;

• If the link tag was an ordinary URI, this returns the URL string; otherwise this property is undefined.

  Remarks

  Either the codeDestination or the urlDestination property will be defined, but never both.

method getChildNodesForContent

protected getChildNodesForContent: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property hasQuotes

readonly hasQuotes: boolean;

• Returns true if the identifier will be rendered as a quoted string literal instead of as a programming language identifier. This is required if the identifier property is not a valid ECMAScript identifier.

property identifier

readonly identifier: string;

• The identifier string without any quote encoding.

  Remarks

  If the value is not a valid ECMAScript identifier, it will be quoted as a string literal during rendering.

property kind

readonly kind: string;

• Modifiers

  • @override

method isValidIdentifier

static isValidIdentifier: (identifier: string) => boolean;

• Tests whether the input string can be used without quotes as a member identifier in a declaration reference. If not, DocMemberIdentifier.hasQuotes will be required.

  Remarks

  In order to be used without quotes, the string must follow the identifier syntax for ECMAScript / TypeScript, and it must not be one of the reserved words used for system selectors (such as instance, static, constructor, etc).

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property hasDot

readonly hasDot: boolean;

• True if this member reference is preceded by a dot (".") token. It should be false only for the first member in the chain.

property kind

readonly kind: string;

• Modifiers

  • @override

property memberIdentifier

readonly memberIdentifier: DocMemberIdentifier;

• The identifier for the referenced member.

  Remarks

  Either memberIdentifier or memberSymbol may be specified, but not both.

property memberSymbol

readonly memberSymbol: DocMemberSymbol;

• The ECMAScript 6 symbol expression, which may be used instead of an identifier to indicate the referenced member.

  Remarks

  Either memberIdentifier or memberSymbol may be specified, but not both.

property selector

readonly selector: DocMemberSelector;

• A TSDoc selector, which may be optionally when the identifier or symbol is insufficient to unambiguously determine the referenced declaration.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property errorMessage

readonly errorMessage: string;

• If the selectorKind is SelectorKind.Error, this string will be defined and provide more detail about why the string was not valid.

property kind

readonly kind: string;

• Modifiers

  • @override

property selector

readonly selector: string;

• The text representation of the selector.

  Remarks

  For system selectors, it will be a predefined lower case name. For label selectors, it will be an upper case name defined using the {@label} tag. For index selectors, it will be a positive integer.

property selectorKind

readonly selectorKind: SelectorKind;

• Indicates the kind of selector.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property kind

readonly kind: string;

• Modifiers

  • @override

property symbolReference

readonly symbolReference: DocDeclarationReference;

• The declaration reference for the ECMAScript 6 symbol that will act as the identifier for the member.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

constructor

constructor(parameters: IDocNodeParameters | IDocNodeParsedParameters);

property configuration

readonly configuration: TSDocConfiguration;

property kind

readonly kind: string;

• Returns a text string that uniquely identifies the child class type. This is used for example by switch statements to efficiently determine the kind of node.

method getChildNodes

getChildNodes: () => ReadonlyArray<DocNode>;

• Returns the list of child nodes for this node. This is useful for visitors that want to scan the tree looking for nodes of a specific type, without having to process intermediary nodes.

method isParsedParameters

static isParsedParameters: (
    parameters: IDocNodeParameters | IDocNodeParsedParameters
) => parameters is IDocNodeParsedParameters;

• A type guard that returns true if the input uses the IDocNodeParsedParameters (parser scenario).

  Remarks

  There are two scenarios for constructing DocNode objects. The "builder scenario" constructs the object based on literal strings, does NOT create DocExcerpt child nodes, and generally uses the IDocNodeParameters hierarchy for its constructor parameters. The "parser scenario" constructs the object by parsing a TypeScript source file, does create DocExcerpt child nodes, and generally uses the IDocNodeParsedParameters hierarchy.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Overridden by child classes to implement DocNode.getChildNodes.

  Modifiers

  • @virtual

property nodes

readonly nodes: readonly DocNode[];

• The nodes that were added to this container.

method appendNode

appendNode: (docNode: DocNode) => void;

• Append a node to the container.

method appendNodes

appendNodes: (docNodes: ReadonlyArray<DocNode>) => void;

• Append nodes to the container.

method clearNodes

clearNodes: () => void;

• Remove all nodes from the container.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

method isAllowedChild

isAllowedChild: (parentKind: string, childKind: string) => boolean;

• Returns true if the specified DocNode kind has been registered as an allowable child of the specified parent DocNode kind.

method registerAllowableChildren

registerAllowableChildren: (
    parentKind: string,
    childKinds: ReadonlyArray<string>
) => void;

• For the given parent DocNode kind, registers the specified DocNode kinds as being allowable children of the parent.

  Remarks

  To prevent mistakes, DocNodeContainer will report an error if you try to add node that was not registered as an allowable child of the container.

method registerDocNodes

registerDocNodes: (
    packageName: string,
    definitions: ReadonlyArray<IDocNodeDefinition>
) => void;

• Registers a list of IDocNodeDefinition objects to be used with the associated TSDocConfiguration object.

method throwIfNotRegisteredKind

throwIfNotRegisteredKind: (docNodeKind: string) => void;

• Reports an error if the specified DocNode kind has not been registered.

method trimSpacesInParagraph

static trimSpacesInParagraph: (docParagraph: DocParagraph) => DocParagraph;

• trimSpacesInParagraphNodes() collapses extra spacing characters from plain text nodes.

  Parameter docParagraph

  a DocParagraph containing nodes to be transformed

  Returns

  The transformed child nodes.

  Remarks

  This is useful when emitting HTML, where any number of spaces are equivalent to a single space. It's also useful when emitting Markdown, where spaces can be misinterpreted as an indented code block.

  For example, we might transform this:

  nodes: [
    { kind: PlainText, text: "   Here   are some   " },
    { kind: SoftBreak }
    { kind: PlainText, text: "   words" },
    { kind: SoftBreak }
    { kind: InlineTag, text: "{\@inheritDoc}" },
    { kind: PlainText, text: "to process." },
    { kind: PlainText, text: "  " },
    { kind: PlainText, text: "  " }
  ]

  ...to this:

  nodes: [
    { kind: PlainText, text: "Here are some " },
    { kind: PlainText, text: "words " },
    { kind: InlineTag, text: "{\@inheritDoc}" },
    { kind: PlainText, text: "to process." }
  ]

  Note that in this example, "words " is not merged with the preceding node because its DocPlainText.excerpt cannot span multiple lines.

property kind

readonly kind: string;

• Modifiers

  • @override

property kind

readonly kind: string;

• Modifiers

  • @override

property parameterName

readonly parameterName: string;

• The name of the parameter that is being documented. For example "width" in @param width - the width of the object.

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property blocks

readonly blocks: readonly DocParamBlock[];

• Returns the blocks in this collection.

property count

readonly count: number;

• Returns the number of blocks in this collection.

property kind

readonly kind: string;

• Modifiers

  • @override

method [Symbol.iterator]

[Symbol.iterator]: () => IterableIterator<DocParamBlock>;

• Provide an iterator for callers that support it.

method add

add: (docParamBlock: DocParamBlock) => void;

• Adds a new block to the collection.

method clear

clear: () => void;

• Removes all blocks from the collection

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

method tryGetBlockByName

tryGetBlockByName: (parameterName: string) => DocParamBlock | undefined;

• Returns the first block whose parameterName matches the specified string.

  Remarks

  If the collection was parsed from an input containing errors, there could potentially be more than one DocParamBlock with the same name. In this situation, tryGetBlockByName() will return the first match that it finds.

  This lookup is optimized using a dictionary.

property kind

readonly kind: string;

• Modifiers

  • @override

property text

readonly text: string;

• The text content.

property textExcerpt

readonly textExcerpt: TokenSequence;

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property kind

readonly kind: string;

• Modifiers

  • @override

method appendNodeInParagraph

appendNodeInParagraph: (docNode: DocNode) => void;

• If the last item in DocSection.nodes is not a DocParagraph, a new paragraph is started. Either way, the provided docNode will be appended to the paragraph.

method appendNodesInParagraph

appendNodesInParagraph: (docNodes: ReadonlyArray<DocNode>) => void;

property kind

readonly kind: string;

• Modifiers

  • @override

method onGetChildNodes

protected onGetChildNodes: () => ReadonlyArray<DocNode | undefined>;

• Modifiers

  • @override

property nodes

readonly nodes: readonly DocBlockTag[];

• The original block tag nodes that defined the modifiers in this set, excluding duplicates.

method addTag

addTag: (blockTag: DocBlockTag) => boolean;

• Adds a new modifier tag to the set. If a tag already exists with the same name, then no change is made, and the return value is false.

method hasTag

hasTag: (modifierTagDefinition: TSDocTagDefinition) => boolean;

• Returns true if the set contains a DocBlockTag matching the specified tag definition. Note that synonyms are not considered. The comparison is case-insensitive. The TSDocTagDefinition must be a modifier tag.

  Parameter tagName

  The name of the tag, including the @ prefix For example, @internal

method hasTagName

hasTagName: (modifierTagName: string) => boolean;

• Returns true if the set contains a DocBlockTag with the specified tag name. Note that synonyms are not considered. The comparison is case-insensitive.

  Parameter modifierTagName

  The name of the tag, including the @ prefix For example, @internal

method tryGetTag

tryGetTag: (
    modifierTagDefinition: TSDocTagDefinition
) => DocBlockTag | undefined;

• Returns a DocBlockTag matching the specified tag definition, or undefined if no such tag was added to the set. If there were multiple instances, returned object will be the first one to be added.

constructor

constructor(configuration: TSDocConfiguration, sourceRange: TextRange);

property commentRange

commentRange: TextRange;

• The text range starting from the opening /** and ending with the closing *\/ delimiter.

property configuration

readonly configuration: TSDocConfiguration;

• The configuration that was provided for the TSDocParser.

property docComment

readonly docComment: DocComment;

• The parsed doc comment object. This is the primary output of the parser.

property lines

lines: TextRange[];

• The text ranges corresponding to the lines of content inside the comment.

property log

readonly log: ParserMessageLog;

• A queryable log that reports warnings and error messages that occurred during parsing.

property sourceRange

readonly sourceRange: TextRange;

• The sourceRange indicates the start and end of the original input that was parsed.

property tokens

tokens: Token[];

• A complete list of all tokens that were extracted from the input lines.

constructor

constructor(parameters: IParserMessageParameters);

property docNode

readonly docNode: DocNode;

property messageId

readonly messageId: TSDocMessageId;

• A string that uniquely identifies the messages reported by the TSDoc parser.

property text

readonly text: string;

• The message text.

property textRange

readonly textRange: TextRange;

property tokenSequence

readonly tokenSequence: TokenSequence;

property unformattedText

readonly unformattedText: string;

• The message text without the default prefix that shows line/column information.

method toString

toString: () => string;

property messages

readonly messages: readonly ParserMessage[];

• The unfiltered list of all messages.

method addMessage

addMessage: (parserMessage: ParserMessage) => void;

• Append a message to the log.

method addMessageForDocErrorText

addMessageForDocErrorText: (docErrorText: DocErrorText) => void;

• Append a message associated with a TokenSequence.

method addMessageForTextRange

addMessageForTextRange: (
    messageId: TSDocMessageId,
    messageText: string,
    textRange: TextRange
) => void;

• Append a message associated with a TextRange.

method addMessageForTokenSequence

addMessageForTokenSequence: (
    messageId: TSDocMessageId,
    messageText: string,
    tokenSequence: TokenSequence,
    docNode?: DocNode
) => void;

• Append a message associated with a TokenSequence.

method hasAnyTextContent

static hasAnyTextContent: {
    (node: DocNode, requiredCharacters?: number): boolean;
    (nodes: readonly DocNode[], requiredCharacters?: number): boolean;
};

• Returns true if the specified node contains any text content.

  Parameter node

  this node and all its children will be considered

  Parameter requiredCharacters

  The test returns true if at least this many non-spacing characters are found. The default value is 1.

  Remarks

  A documentation tool can use this test to report warnings when a developer neglected to write a code comment for a declaration.

• Returns true if the specified collection of nodes contains any text content.

  Parameter nodes

  the collection of nodes to be tested

  Parameter requiredCharacters

  The test returns true if at least this many non-spacing characters are found. The default value is 1.

  Remarks

  A documentation tool can use this test to report warnings when a developer neglected to write a code comment for a declaration.

method isAlpha

isAlpha: () => boolean;

• Returns true if the @alpha modifier tag was specified.

method isBeta

isBeta: () => boolean;

• Returns true if the @beta modifier tag was specified.

method isEventProperty

isEventProperty: () => boolean;

• Returns true if the @eventProperty modifier tag was specified.

method isExperimental

isExperimental: () => boolean;