Class TypeScript::TypeAccess

A possibly qualified name that is used as part of a type, such as Date or http.ServerRequest.

Type arguments are not part of a type access but there are convenience methods in this class for accessing them.

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getATypeArgument

Gets a type argument provided to this type by the enclosing generic type expression, if any.

getAsGenericType

Gets the enclosing generic type expression providing type arguments to this type, if any.

getIdentifier

Gets the identifier naming the type without any qualifier, such as ServerRequest in http.ServerRequest.

getNumTypeArgument

Gets the number of type arguments provided to this type by the enclosing generic type expression, if any, or 0 otherwise.

getTypeArgument

Gets the nth type argument provided to this type by the enclosing generic type expression, if any.

getTypeName

Gets the canonical name of the type being accessed.

hasQualifiedName

Holds if this is a reference to the type with qualified name globalName relative to the global scope.

hasQualifiedName

Holds if this is a reference to the type exported from moduleName under the name exportedName.

hasTypeArguments

Holds if there are type arguments provided to this type by an enclosing generic type expression.

Inherited predicates

getAChild

Gets a child node of this node.

from ASTNode
getAChildExpr

Gets a child expression of this node.

from ASTNode
getAChildStmt

Gets a child statement of this node.

from ASTNode
getAToken

Gets a token belonging to this element.

from ASTNode
getAnUnderlyingType

Repeatedly unfolds unions, intersections, parentheses, and nullability/readonly modifiers and gets any of the underlying types, or this type itself if it cannot be unfolded.

from TypeAnnotation
getChild

Gets the ith child node of this node.

from ASTNode
getChildExpr

Gets the ith child expression of this node.

from ASTNode
getChildStmt

Gets the ith child statement of this node.

from ASTNode
getChildTypeExpr

Gets the ith child type expression of this node.

from ASTNode
getClass

Gets the class referenced by this type annotation, if any.

from TypeExpr
getContainerfrom TypeExpr
getDocumentation

Gets the JSDoc comment associated with this expression or type or its parent statement, if any.

from ExprOrType
getEnclosingFunctionfrom TypeExpr
getEnclosingStmtfrom TypeExpr
getEndLine

Gets the line on which this element ends.

from Locatable
getFile

Gets the file this program element comes from.

from Locatable
getFirstControlFlowNode

Gets the first control flow node belonging to this syntactic entity.

from ASTNode
getFirstToken

Gets the first token belonging to this element.

from ASTNode
getLastToken

Gets the last token belonging to this element.

from ASTNode
getLocation

Gets this element’s location.

from ASTNode
getNumChild

Gets the number of child nodes of this node.

from ASTNode
getNumChildExpr

Gets the number of child expressions of this node.

from ASTNode
getNumChildStmt

Gets the number of child statements of this node.

from ASTNode
getNumLines

Gets the number of lines covered by this element.

from Locatable
getParent

Gets the parent node of this node, if any.

from ASTNode
getStartLine

Gets the line on which this element starts.

from Locatable
getTopLevelfrom TypeExpr
getType

Gets the static type expressed by this type annotation.

from TypeExpr
getUnderlyingReference

Gets the innermost reference that this expression evaluates to, if any.

from ExprOrType
getUnderlyingValue

Gets the innermost expression that this expression evaluates to.

from ExprOrType
inExternsFile

Holds if this syntactic entity belongs to an externs file.

from ASTNode
isAmbient

Holds if this is part of an ambient declaration or type annotation in a TypeScript file.

from TypeExpr
isAny

Holds if this is the any type.

from TypeAnnotation
isBigInt

Holds if this is the bigint type.

from TypeAnnotation
isBoolean

Holds if this is the boolean type. Does not hold for the (rarely used) Boolean type.

from TypeAnnotation
isBooleany

Holds if this is the boolean or Boolean type.

from TypeAnnotation
isConstKeyword

Holds if this is the const keyword, occurring in a type assertion such as x as const.

from TypeAnnotation
isNever

Holds if this is the never type, or an equivalent type representing the empty set of values.

from TypeAnnotation
isNull

Holds if this is the null type.

from TypeAnnotation
isNumber

Holds if this is the number type. Does not hold for the (rarely used) Number type.

from TypeAnnotation
isNumbery

Holds if this is the number or Numbers type.

from TypeAnnotation
isObjectKeyword

Holds if this is the object type.

from TypeAnnotation
isRawFunction

Holds if this is the Function type.

from TypeAnnotation
isString

Holds if this is the string type. Does not hold for the (rarely used) String type.

from TypeAnnotation
isStringy

Holds if this is the string or String type.

from TypeAnnotation
isSymbol

Holds if this is the symbol type.

from TypeAnnotation
isThis

Holds if this is the this type.

from TypeAnnotation
isUndefined

Holds if this is the undefined type.

from TypeAnnotation
isUniqueSymbol

Holds if this is the unique symbol type.

from TypeAnnotation
isUnknownKeyword

Holds if this is the unknown type.

from TypeAnnotation
isVoid

Holds if this is the void type.

from TypeAnnotation
stripParens

Gets this expression or type, with any surrounding parentheses removed.

from ExprOrType
toString

Gets a textual representation of this element.

from TypeExpr