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

Class JSDoc::Environment

A statement container which may declare JSDoc name aliases.

Import path

import javascript

Direct supertypes

Indirect supertypes

Predicates

getNodeFromAlias

Gets a data flow node from which the type name alias should be resolved.

isContainerInScope

Holds if the aliases declared in this environment should be in scope within the given container.

resolveAlias

Gets the fully qualified name aliased by the given unqualified name within this container.

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
getAPrimaryQlClass

Gets the primary QL class for the Locatable.

from Locatable
getAStmt

Gets a statement that belongs to this container.

from StmtContainer
getAToken

Gets a token belonging to this element.

from AstNode
getBody

Gets the body of this container.

from StmtContainer
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
getEnclosingContainer

Gets the innermost enclosing container in which this container is nested.

from StmtContainer
getEndLine

Gets the line on which this element ends.

from Locatable
getEntry

Gets the (unique) entry node of the control flow graph for this toplevel or function.

from StmtContainer
getEntryBB

Gets the entry basic block of this function, that is, the basic block containing the entry node of its CFG.

from StmtContainer
getExit

Gets the (unique) exit node of the control flow graph for this toplevel or function.

from StmtContainer
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
getFunctionBoundary

Gets the innermost enclosing function or top-level, possibly this container itself if it is a function or top-level.

from StmtContainer
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
getScope

Gets the scope induced by this toplevel or function, if any.

from StmtContainer
getStart

Gets the (unique) CFG node at which execution of this toplevel or function begins.

from StmtContainer
getStartBB

Gets the start basic block of this function, that is, the basic block containing the start node of its CFG.

from StmtContainer
getStartLine

Gets the line on which this element starts.

from Locatable
getTopLevel

Gets the toplevel syntactic unit to which this element belongs.

from AstNode
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
isStrict

Holds if the code in this container is executed in ECMAScript strict mode.

from StmtContainer
toString

Gets a textual representation of this element.

from Locatable