Package-level declarations
Types
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.
A list of comma-separated expressions. This node is only created by transformations.
This is either an export = or an export default declaration. Unless isExportEquals is set, this node was parsed as an export default.
Several node kinds share function-like features such as a signature, a name, and a body. These nodes should extend FunctionLikeDeclarationBase. Examples:
One of:
Deprecated, please use UpdateExpression
Note that @extends is a synonym of @augments. Both tags are represented by this interface.
Class#method reference in JSDoc
Unlike ObjectLiteralElement, excludes JSXAttribute and JSXSpreadAttribute.
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.)
Brand for a PropertyAccessExpression which, like a QualifiedName, consists of a sequence of identifiers separated by dots.
Represents a bigint literal value without requiring bigint support
For when we encounter a semicolon in a class declaration. ES6 allows these as class elements.
Subset of properties from SourceFile that are used in multiple utility functions
Functions
Gets all JSDoc tags that match a specified predicate
Gets all JSDoc tags of a specified kind
Gets a custom text range to use when emitting comments.
Gets the constant value to emit for an expression representing an enum.
Gets the effective type parameters. If the node was parsed in a JavaScript file, gets the type parameters from the @template tag from JSDoc.
Gets the JSDoc augments tag for the node if present
Gets the JSDoc class tag for the node if present
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}.
Gets the JSDoc deprecated tag for the node if present
Gets the JSDoc enum tag for the node if present
Gets the JSDoc implements tags for the node if present
Gets the JSDoc parameter tags for the node if present.
Gets the JSDoc private tag for the node if present
Gets the JSDoc protected tag for the node if present
Gets the JSDoc public tag for the node if present
Gets the JSDoc protected tag for the node if present
Gets the JSDoc return tag for the node if present
Gets the return type node for the node if provided via JSDoc return tag or type tag.
Get all JSDoc tags related to a node, including those on parent nodes.
Gets the JSDoc template tag for the node if present
Gets the JSDoc this tag for the node if present
Gets the type node for the node if provided via JSDoc.
Gets the JSDoc type parameter tags for the node if present.
Gets the JSDoc type tag for the node if present and valid
Gets the text of a jsdoc comment, flattening links to their text.
Return true if the node has JSDoc parameter tags.