CodeQL library for JavaScript/TypeScript
codeql/javascript-all 1.0.3-dev (changelog, source)
Search

Class KeywordTypeExpr

Classes that are internally represented as a keyword type.

Import path

import javascript

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

Gets the primary QL class for the Locatable.

getName
isAny

Holds if this is the any type.

isBigInt

Holds if this is the bigint type.

isBoolean

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

isBooleany

Holds if this is the boolean or Boolean type.

isConstKeyword

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

isNever

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

isNull

Holds if this is the null type.

isNumber

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

isNumbery

Holds if this is the number or Numbers type.

isObjectKeyword

Holds if this is the object type.

isString

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

isStringy

Holds if this is the string or String type.

isSymbol

Holds if this is the symbol type.

isThis

Holds if this is the this type.

isUndefined

Holds if this is the undefined type.

isUniqueSymbol

Holds if this is the unique symbol type.

isUnknownKeyword

Holds if this is the unknown type.

isVoid

Holds if this is the void type.

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
getContainer

Gets the function or toplevel to which this node belongs.

from NodeInStmtContainer
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 AstNode
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 Locatable
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
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

from Locatable
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
hasQualifiedName

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

from TypeAnnotation
hasQualifiedName

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

from TypeAnnotation
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 AstNode
isRawFunction

Holds if this is the Function 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