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

Class ForOfStmt

A for-of loop.

Example:

for(var elt of arr) {
  sum += elt;
}

Import path

import javascript

Direct supertypes

Indirect supertypes

Predicates

getAPrimaryQlClass

Gets the primary QL class for the Locatable.

isAwait

Holds if this is a for-await-of statement.

Inherited predicates

describeControlFlowNode

For internal use.

from ControlFlowNode
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
getAControlledStmt

Gets a statement controlled by this control statement.

from LoopStmt
getAPredecessor

Gets a node preceding this node in the CFG.

from ControlFlowNode
getASuccessor

Gets a node succeeding this node in the CFG.

from ControlFlowNode
getAToken

Gets a token belonging to this element.

from AstNode
getAnIterationVariable

Gets an iterator variable of this for-in or for-of loop.

from EnhancedForLoop
getBasicBlock

Gets the basic block this node belongs to.

from ControlFlowNode
getBody

Gets the body of this loop.

from EnhancedForLoop
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
getContainer

Gets the function or toplevel to which this node belongs.

from NodeInStmtContainer
getDefault

Gets the default value of the loop’s iterator, if any.

from EnhancedForLoop
getDocumentation

Gets the JSDoc comment for this element, if any.

from Documentable
getEnclosingTryCatchStmt

Gets the try statement with a catch block containing this statement without crossing function boundaries or other try statements with catch blocks.

from Stmt
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 EnhancedForLoop
getFirstToken

Gets the first token belonging to this element.

from AstNode
getIterationDomain

Gets the expression this for-in or for-of loop iterates over.

from EnhancedForLoop
getIterator

Gets the iterator of this for-in or for-of loop; this can be either a pattern, a property reference, or a variable declaration statement.

from EnhancedForLoop
getIteratorExpr

Gets the iterator expression of this for-in or for-of loop; this can be either a variable access or a variable declarator.

from EnhancedForLoop
getKind

Gets the kind of this statement, which is an integer value representing the statement’s node type.

from Stmt
getLValue

Gets the property, variable, or destructuring pattern occurring as the iterator expression in this for-in or for-of loop.

from EnhancedForLoop
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
getParentStmt

Gets the statement that is the parent of this statement in the AST, if any.

from Stmt
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
getTest

Gets the loop test of this loop.

from EnhancedForLoop
getTopLevel

Gets the toplevel syntactic unit to which this element belongs.

from AstNode
hasSemicolonInserted

Holds if this statement has an implicitly inserted semicolon.

from Stmt
inExternsFile

Holds if this syntactic entity belongs to an externs file.

from AstNode
isAFinalNode

Holds if this is a final node, that is, a CFG node where execution of a toplevel or function terminates.

from ControlFlowNode
isAFinalNodeOfContainer

Holds if this is a final node of container, that is, a CFG node where execution of that toplevel or function terminates.

from ControlFlowNode
isAmbient

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

from AstNode
isBranch

Holds if this is a node with more than one successor.

from ControlFlowNode
isJoin

Holds if this is a node with more than one predecessor.

from ControlFlowNode
isStart

Holds if this is a start node, that is, the CFG node where execution of a toplevel or function begins.

from ControlFlowNode
isSubjectToSemicolonInsertion

Holds if automatic semicolon insertion applies to this statement.

from Stmt
isUnreachable

Holds if this node is unreachable, that is, it has no predecessors in the CFG. Entry nodes are always considered reachable.

from ControlFlowNode
nestedIn

Holds if this statement is lexically nested inside statement outer.

from Stmt
toString

Gets a textual representation of this element.

from Stmt