Package-level declarations

Types

Link copied to clipboard
typealias __String = Any

This represents a string whose leading underscore have been escaped by adding extra leading underscores. The shape of this brand is rather unique compared to others we've used. Instead of just an intersection of a string and an object, it is that union-ed with an intersection of void and an object. This makes it wholly incompatible with a normal string (which is good, it cannot be misused on assignment or on usage), while still being comparable with a normal string via === (also good) and castable from a string.

Link copied to clipboard
sealed external interface AccessExpression : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface AmdDependency
Link copied to clipboard
sealed external interface ArrayBindingElement : Node
Link copied to clipboard
sealed external interface ArrayBindingPatternParent : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface AssertionExpression : Node, HasType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface AssignmentPattern : Node
Link copied to clipboard
Link copied to clipboard
external interface AwaitExpression : UnaryExpression
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface BinaryOperator : SyntaxKind
Link copied to clipboard
Link copied to clipboard
sealed external interface BindingName : Node, DeclarationName
Link copied to clipboard
sealed external interface BindingOrAssignmentElement : Node
Link copied to clipboard
sealed external interface BindingOrAssignmentElementRestIndicator : Node
Link copied to clipboard
sealed external interface BindingOrAssignmentElementTarget : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface BlockLike : Node
Link copied to clipboard
sealed external interface BreakOrContinueStatement : Node
Link copied to clipboard
Link copied to clipboard
external interface Bundle : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface CallLikeExpression : Node
Link copied to clipboard
external interface CaseBlock : Node, LocalsContainer
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface CaseOrDefaultClause : Node, BlockLike
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface ClassLikeDeclarationBaseKind : SyntaxKind
Link copied to clipboard
sealed external interface ClassMemberModifier : Node
Link copied to clipboard
sealed external interface ClassStaticBlockDeclarationParent : Node
Link copied to clipboard
Link copied to clipboard
external interface CommaListExpression : Expression

A list of comma-separated expressions. This node is only created by transformations.

Link copied to clipboard
sealed external interface CommentKind : SyntaxKind
Link copied to clipboard
Link copied to clipboard
external interface ComputedPropertyName : Node, PropertyName
Link copied to clipboard
sealed external interface ConciseBody : Node
Link copied to clipboard
external interface ConditionalExpression : Expression
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface Declaration : Node
Link copied to clipboard
sealed external interface DeclarationName : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface DeclarationStatementName : Node, DeclarationName
Link copied to clipboard
sealed external interface DeclarationWithTypeParameters : Node
Link copied to clipboard
Link copied to clipboard
external interface DefaultClause : Node, CaseOrDefaultClause
Link copied to clipboard
external interface DeleteExpression : UnaryExpression
Link copied to clipboard
sealed external interface DestructuringAssignment : Node
Link copied to clipboard
sealed external interface DestructuringPattern : Node
Link copied to clipboard
external interface DocumentSpan
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external class EmitHint
Link copied to clipboard
external interface EmptyStatement : Statement, HasJSDoc
Link copied to clipboard
Link copied to clipboard
sealed external interface EntityNameOrEntityNameExpression : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This is either an export = or an export default declaration. Unless isExportEquals is set, this node was parsed as an export default.

Link copied to clipboard
sealed external interface ExportDeclarationParent : Node
Link copied to clipboard
Link copied to clipboard
external interface Expression : Node, ConciseBody, ForInitializer
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface FileReference : TextRange
Link copied to clipboard
external interface FlowContainer : Node
Link copied to clipboard
sealed external interface ForInitializer : Node
Link copied to clipboard
sealed external interface ForInOrOfStatement : Node
Link copied to clipboard
sealed external interface FunctionBody : Block, ConciseBody
Link copied to clipboard
sealed external interface FunctionLikeDeclaration : Node
Link copied to clipboard

Several node kinds share function-like features such as a signature, a name, and a body. These nodes should extend FunctionLikeDeclarationBase. Examples:

Link copied to clipboard
sealed external interface FunctionOrConstructorTypeNode : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface GetAccessorDeclarationParent : Node
Link copied to clipboard
sealed external interface GetJSDocCommentsAndTagsResultItem : Node
Link copied to clipboard
sealed external interface HasDecorators : Node
Link copied to clipboard
sealed external interface HasExpressionInitializer : Node, HasInitializer
Link copied to clipboard
sealed external interface HasInitializer : Node
Link copied to clipboard
sealed external interface HasJSDoc : Node
Link copied to clipboard
sealed external interface HasModifiers : Node
Link copied to clipboard
sealed external interface HasType : Node
Link copied to clipboard
sealed external interface HasTypeArguments : Node
Link copied to clipboard
external interface HeritageClause : Node
Link copied to clipboard
sealed external interface HeritageClauseParent : Node
Link copied to clipboard
sealed external interface HeritageClauseToken : SyntaxKind
Link copied to clipboard
Link copied to clipboard
external interface ImportAttribute : Node
Link copied to clipboard
sealed external interface ImportAttributeName : Node
Link copied to clipboard
external interface ImportAttributes : Node
Link copied to clipboard
sealed external interface ImportAttributesParent : Node
Link copied to clipboard
sealed external interface ImportAttributesToken : SyntaxKind
Link copied to clipboard
external interface ImportCall : CallExpression
Link copied to clipboard
sealed external interface ImportCallExpression : Node, LeftHandSideExpression
Link copied to clipboard
Link copied to clipboard
sealed external interface ImportClauseParent : Node
Link copied to clipboard
sealed external interface ImportDeclarationParent : Node
Link copied to clipboard
Link copied to clipboard
external interface ImportDeferPropertyName : Identifier
Link copied to clipboard
sealed external interface ImportEqualsDeclarationParent : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface ImportPhaseModifierSyntaxKind : SyntaxKind
Link copied to clipboard
Link copied to clipboard

Deprecated, please use UpdateExpression

Link copied to clipboard
external interface IndexedAccessTypeNode : TypeNode
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external class InternalSymbolName
Link copied to clipboard
Link copied to clipboard
sealed external interface IsCallOrNewExpressionResultPredicate : Node
Link copied to clipboard
sealed external interface IsClassOrTypeElementResultPredicate : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface IsIterationStatementResultPredicate : Node
Link copied to clipboard
sealed external interface IsJSDocLinkLikeResultPredicate : Node
Link copied to clipboard
sealed external interface IsLiteralTypeLiteralResultPredicate : Node
Link copied to clipboard
sealed external interface IsOptionalChainResultPredicate : Node
Link copied to clipboard
Link copied to clipboard
external interface JSDocAllType : JSDocType
Link copied to clipboard
external interface JSDocAugmentsTag : JSDocTag

Note that @extends is a synonym of @augments. Both tags are represented by this interface.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface JSDocAuthorTag : JSDocTag
Link copied to clipboard
sealed external interface JSDocCallbackTagFullName : Node
Link copied to clipboard
external interface JSDocClassTag : JSDocTag
Link copied to clipboard
sealed external interface JSDocComment : Node
Link copied to clipboard
external interface JSDocContainer : Node
Link copied to clipboard
external interface JSDocDeprecatedTag : JSDocTag
Link copied to clipboard
Link copied to clipboard
external interface JSDocImplementsTag : JSDocTag
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface JSDocLinkCodeName : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface JSDocLinkName : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface JSDocLinkPlainName : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface JSDocMemberNameLeft : Node
Link copied to clipboard
external interface JSDocNamepathType : JSDocType
Link copied to clipboard
external interface JSDocNameReference : Node
Link copied to clipboard
sealed external interface JSDocNameReferenceName : Node
Link copied to clipboard
sealed external interface JSDocNamespaceBody : Node, ModuleBody
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface JSDocOverloadTag : JSDocTag
Link copied to clipboard
external interface JSDocOverrideTag : JSDocTag
Link copied to clipboard
Link copied to clipboard
external class JSDocParsingMode
Link copied to clipboard
external interface JSDocPrivateTag : JSDocTag
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface JSDocProtectedTag : JSDocTag
Link copied to clipboard
external interface JSDocPublicTag : JSDocTag
Link copied to clipboard
external interface JSDocReadonlyTag : JSDocTag
Link copied to clipboard
external interface JSDocReturnTag : JSDocTag
Link copied to clipboard
external interface JSDocSatisfiesTag : JSDocTag
Link copied to clipboard
external interface JSDocSeeTag : JSDocTag
Link copied to clipboard
sealed external interface JSDocSyntaxKind : SyntaxKind
Link copied to clipboard
Link copied to clipboard
sealed external interface JSDocTagParent : Node
Link copied to clipboard
Link copied to clipboard
external interface JSDocText : Node, JSDocComment
Link copied to clipboard
external interface JSDocThisTag : JSDocTag
Link copied to clipboard
external interface JSDocThrowsTag : JSDocTag
Link copied to clipboard
external interface JSDocType : TypeNode
Link copied to clipboard
sealed external interface JSDocTypedefTagFullName : Node
Link copied to clipboard
sealed external interface JSDocTypedefTagTypeExpression : Node
Link copied to clipboard
sealed external interface JSDocTypeReferencingNode : Node
Link copied to clipboard
external interface JSDocTypeTag : JSDocTag
Link copied to clipboard
external interface JSDocUnknownTag : JSDocTag
Link copied to clipboard
external interface JSDocUnknownType : JSDocType
Link copied to clipboard
Link copied to clipboard
sealed external interface JsonObjectExpression : Node, Expression
Link copied to clipboard
external interface JsonSourceFile : SourceFile
Link copied to clipboard
sealed external interface JsxAttributeLike : Node, JsxExpressionParent
Link copied to clipboard
sealed external interface JsxAttributeName : Node, DeclarationName
Link copied to clipboard
Link copied to clipboard
sealed external interface JsxAttributeValue : Node
Link copied to clipboard
sealed external interface JsxCallLike : Node, CallLikeExpression
Link copied to clipboard
sealed external interface JsxChild : Node
Link copied to clipboard
external interface JsxClosingElement : Node
Link copied to clipboard
external interface JsxClosingFragment : Expression
Link copied to clipboard
sealed external interface JsxExpressionParent : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface JsxOpeningLikeElement : Node, JsxCallLike
Link copied to clipboard
Link copied to clipboard
sealed external interface JsxTagNameExpression : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface JsxTextParent : Node
Link copied to clipboard
sealed external interface JsxTokenSyntaxKind : SyntaxKind
Link copied to clipboard
Link copied to clipboard
external interface KeywordToken<TKind : KeywordSyntaxKind> : Token<TKind>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external class LanguageVariant
Link copied to clipboard
Link copied to clipboard
external interface LineAndCharacter
Link copied to clipboard
external interface LiteralLikeNode : Node
Link copied to clipboard
sealed external interface LiteralSyntaxKind : SyntaxKind, TokenSyntaxKind
Link copied to clipboard
sealed external interface LiteralToken : Node
Link copied to clipboard
external interface LiteralTypeNode : TypeNode
Link copied to clipboard
sealed external interface LiteralTypeNodeLiteral : Node
Link copied to clipboard
external interface LocalsContainer : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface MappedTypeNodeQuestionToken : Node
Link copied to clipboard
sealed external interface MappedTypeNodeReadonlyToken : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface MemberName : Node, DeclarationName
Link copied to clipboard
Link copied to clipboard
sealed external interface MetaPropertyKeywordToken : SyntaxKind
Link copied to clipboard
sealed external interface MethodDeclarationParent : Node
Link copied to clipboard
sealed external interface MethodSignatureParent : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface Modifier : Node, ModifierLike
Link copied to clipboard
Link copied to clipboard
sealed external interface ModifierLike : Node
Link copied to clipboard
sealed external interface ModifierSyntaxKind : SyntaxKind, KeywordSyntaxKind
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface ModuleDeclarationBody : Node
Link copied to clipboard
sealed external interface ModuleDeclarationParent : Node
Link copied to clipboard
sealed external interface ModuleExportName : Node, DeclarationName
Link copied to clipboard
sealed external interface ModuleName : Node, DeclarationStatementName
Link copied to clipboard
sealed external interface ModuleReference : Node
Link copied to clipboard
Link copied to clipboard
external interface NamedDeclaration : Declaration
Link copied to clipboard
sealed external interface NamedExportBindings : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface NamedImportBindings : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface NamedImportsOrExports : Node
Link copied to clipboard
sealed external interface NamespaceBody : Node, ModuleBody
Link copied to clipboard
Link copied to clipboard
external interface Node : ReadonlyTextRange
Link copied to clipboard
typealias NodeArray<T> = ReadonlyArray<T>
Link copied to clipboard
sealed external interface NodeFactoryCreateLiteralTypeNodeLiteral
Link copied to clipboard
sealed external interface NodeFactoryUpdateLiteralTypeNodeLiteral
Link copied to clipboard
external class NodeFlags : Bitmask<NodeFlags>
Link copied to clipboard
external interface NodeWithTypeArguments : TypeNode
Link copied to clipboard
Link copied to clipboard
external interface NotEmittedStatement : Statement
Link copied to clipboard
external interface NotEmittedTypeElement : TypeElement
Link copied to clipboard
sealed external interface ObjectBindingPatternParent : Node
Link copied to clipboard
Link copied to clipboard

Unlike ObjectLiteralElement, excludes JSXAttribute and JSXSpreadAttribute.

Link copied to clipboard

This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.)

Link copied to clipboard
sealed external interface ObjectTypeDeclaration : Node
Link copied to clipboard
sealed external interface OptionalChain : Node
Link copied to clipboard
external interface OptionalTypeNode : TypeNode
Link copied to clipboard
Link copied to clipboard
sealed external interface ParameterPropertyModifier : Node
Link copied to clipboard
external interface ParenthesizedTypeNode : TypeNode, HasType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface PostfixUnaryOperator : SyntaxKind
Link copied to clipboard
sealed external interface PrefixUnaryOperator : SyntaxKind
Link copied to clipboard
external interface PrimaryExpression : MemberExpression
Link copied to clipboard
Link copied to clipboard

Brand for a PropertyAccessExpression which, like a QualifiedName, consists of a sequence of identifiers separated by dots.

Link copied to clipboard
sealed external interface PropertyName : Node, DeclarationName
Link copied to clipboard
sealed external interface PropertyNameLiteral : Node
Link copied to clipboard
sealed external interface PropertySignatureParent : Node
Link copied to clipboard
external interface PseudoBigInt

Represents a bigint literal value without requiring bigint support

Link copied to clipboard
Link copied to clipboard
sealed external interface PseudoLiteralToken : Node, TemplateLiteralToken
Link copied to clipboard
Link copied to clipboard
sealed external interface PunctuationSyntaxKind : SyntaxKind, TokenSyntaxKind
Link copied to clipboard
Link copied to clipboard
external interface ReadonlyTextRange
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface RestTypeNode : TypeNode
Link copied to clipboard
Link copied to clipboard
external interface SatisfiesExpression : Expression
Link copied to clipboard
external class ScriptKind
Link copied to clipboard
external class ScriptTarget
Link copied to clipboard

For when we encounter a semicolon in a class declaration. ES6 allows these as class elements.

Link copied to clipboard
sealed external interface SetAccessorDeclarationParent : Node
Link copied to clipboard
sealed external interface ShiftOperator : SyntaxKind, ShiftOperatorOrHigher
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface SignatureDeclarationField : Node
Link copied to clipboard
external interface SourceFileLike

Subset of properties from SourceFile that are used in multiple utility functions

Link copied to clipboard
Link copied to clipboard
sealed external interface SpreadElementParent : Node
Link copied to clipboard
external interface Statement : Node, JSDocContainer
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface SuperCall : CallExpression
Link copied to clipboard
Link copied to clipboard
sealed external interface SuperProperty : Node
Link copied to clipboard
Link copied to clipboard
external interface SymbolDisplayPart
Link copied to clipboard
external interface SyntaxKind
Link copied to clipboard
external interface SyntaxList : Node
Link copied to clipboard
external interface SyntheticExpression : Expression
Link copied to clipboard
sealed external interface SyntheticExpressionTupleNameSource : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface TemplateHeadParent : Node
Link copied to clipboard
sealed external interface TemplateLiteral : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface TemplateLiteralTypeSpanLiteral : Node
Link copied to clipboard
sealed external interface TemplateMiddleParent : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface TemplateSpanLiteral : Node
Link copied to clipboard
sealed external interface TemplateTailParent : Node
Link copied to clipboard
external interface TextChangeRange
Link copied to clipboard
external interface TextRange
Link copied to clipboard
external interface TextSpan
Link copied to clipboard
Link copied to clipboard
external interface Token<out TKind : SyntaxKind> : Node
Link copied to clipboard
external class TokenFlags : Bitmask<TokenFlags>
Link copied to clipboard
sealed external interface TokenSyntaxKind : SyntaxKind
Link copied to clipboard
external interface TransientIdentifier : Identifier
Link copied to clipboard
sealed external interface TriviaSyntaxKind : SyntaxKind, TokenSyntaxKind
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface TsConfigSourceFile : JsonSourceFile
Link copied to clipboard
Link copied to clipboard
sealed external interface TupleTypeNodeElementsItem : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface TypeOfExpression : UnaryExpression
Link copied to clipboard
sealed external interface TypeOnlyAliasDeclaration
Link copied to clipboard
sealed external interface TypeOnlyCompatibleAliasDeclaration : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface TypeOperatorNode : TypeNode, HasType
Link copied to clipboard
sealed external interface TypeOperatorNodeOperator : SyntaxKind
Link copied to clipboard
sealed external interface TypeParameterDeclarationParent : Node
Link copied to clipboard
external interface TypePredicateNode : TypeNode, HasType
Link copied to clipboard
sealed external interface TypePredicateNodeParameterName : Node
Link copied to clipboard
sealed external interface TypePredicateNodeParent : Node
Link copied to clipboard
Link copied to clipboard
sealed external interface TypeReferenceNodeField : Node
Link copied to clipboard
sealed external interface TypeReferenceType : Node
Link copied to clipboard
external interface UnaryExpression : Expression
Link copied to clipboard
sealed external interface UnionOrIntersectionTypeNode : Node
Link copied to clipboard
Link copied to clipboard
external interface UpdateExpression : UnaryExpression
Link copied to clipboard
sealed external interface VariableDeclarationListParent : Node
Link copied to clipboard
sealed external interface VariableDeclarationParent : Node
Link copied to clipboard
sealed external interface VariableLikeDeclaration : Node
Link copied to clipboard
external interface VoidExpression : UnaryExpression
Link copied to clipboard
sealed external interface WalkUpBindingElementsAndPatternsResult : Node
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface YieldExpression : Expression

Functions

Link copied to clipboard
external fun <T : JSDocTag> getAllJSDocTags(node: Node, predicate: (tag: JSDocTag) -> Boolean): ReadonlyArray<T>

Gets all JSDoc tags that match a specified predicate

Link copied to clipboard

Gets all JSDoc tags of a specified kind

Link copied to clipboard
external fun getCombinedNodeFlags(node: Node): NodeFlags
Link copied to clipboard
external fun getCommentRange(node: Node): TextRange

Gets a custom text range to use when emitting comments.

Link copied to clipboard
external fun getConstantValue(node: AccessExpression): Any?

Gets the constant value to emit for an expression representing an enum.

Link copied to clipboard
Link copied to clipboard

Gets the effective type parameters. If the node was parsed in a JavaScript file, gets the type parameters from the @template tag from JSDoc.

Link copied to clipboard

Gets the JSDoc augments tag for the node if present

Link copied to clipboard
external fun getJSDocClassTag(node: Node): JSDocClassTag?

Gets the JSDoc class tag for the node if present

Link copied to clipboard

This function checks multiple locations for JSDoc comments that apply to a host node. At each location, the whole comment may apply to the node, or only a specific tag in the comment. In the first case, location adds the entire {@link JSDoc} object. In the second case, it adds the applicable {@link JSDocTag}.

Link copied to clipboard

Gets the JSDoc deprecated tag for the node if present

Link copied to clipboard
external fun getJSDocEnumTag(node: Node): JSDocEnumTag?

Gets the JSDoc enum tag for the node if present

Link copied to clipboard

Gets the JSDoc implements tags for the node if present

Link copied to clipboard
Link copied to clipboard

Gets the JSDoc parameter tags for the node if present.

Link copied to clipboard

Gets the JSDoc private tag for the node if present

Link copied to clipboard

Gets the JSDoc protected tag for the node if present

Link copied to clipboard
external fun getJSDocPublicTag(node: Node): JSDocPublicTag?

Gets the JSDoc public tag for the node if present

Link copied to clipboard

Gets the JSDoc protected tag for the node if present

Link copied to clipboard
external fun getJSDocReturnTag(node: Node): JSDocReturnTag?

Gets the JSDoc return tag for the node if present

Link copied to clipboard
external fun getJSDocReturnType(node: Node): TypeNode?

Gets the return type node for the node if provided via JSDoc return tag or type tag.

Link copied to clipboard
Link copied to clipboard
external fun getJSDocTags(node: Node): ReadonlyArray<JSDocTag>

Get all JSDoc tags related to a node, including those on parent nodes.

Link copied to clipboard

Gets the JSDoc template tag for the node if present

Link copied to clipboard
external fun getJSDocThisTag(node: Node): JSDocThisTag?

Gets the JSDoc this tag for the node if present

Link copied to clipboard
external fun getJSDocType(node: Node): TypeNode?

Gets the type node for the node if provided via JSDoc.

Link copied to clipboard

Gets the JSDoc type parameter tags for the node if present.

Link copied to clipboard
external fun getJSDocTypeTag(node: Node): JSDocTypeTag?

Gets the JSDoc type tag for the node if present and valid

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external fun getNameOfJSDocTypedef(declaration: JSDocTypedefTag): Any?
Link copied to clipboard
external fun getOriginalNode(node: Node): Node
external fun getOriginalNode(node: Node?): Node?
external fun <T : Node> getOriginalNode(node: Node, nodeTest: (node: Node) -> Boolean): T
external fun <T : Node> getOriginalNode(node: Node?, nodeTest: (node: Node) -> Boolean): T?
Link copied to clipboard
external fun getParseTreeNode(node: Node?): Node?
external fun <T : Node> getParseTreeNode(node: T?, nodeTest: (node: Node) -> Boolean = definedExternally): T?

Gets the original parse tree node for a node.

Link copied to clipboard
external fun getPositionOfLineAndCharacter(sourceFile: SourceFileLike, line: Int, character: Int): Int
Link copied to clipboard
external fun getTextOfJSDocComment(): String?
external fun getTextOfJSDocComment(comment: NodeArray<JSDocComment> = definedExternally): String?
external fun getTextOfJSDocComment(comment: String = definedExternally): String?

Gets the text of a jsdoc comment, flattening links to their text.

Link copied to clipboard
Link copied to clipboard

Return true if the node has JSDoc parameter tags.