Class Functions::Function

A function as defined either by a function declaration or a function expression.

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

declaresArguments

Holds if this function declares a parameter or local variable named arguments.

describe

Gets a description of this function.

getABodyStmt

Gets a statement in the body of this function.

getAParameter

Gets a parameter of this function.

getAReturnStmt

Gets a return statement in the body of this function, if any.

getAReturnedExpr

Gets an expression that could be returned by this function, if any.

getArgumentsVariable

Gets the arguments variable of this function, if any.

getBody

Gets the body of this function.

getBodyStmt

Gets the ith statement in the body of this function.

getCanonicalName

Gets the canonical name for this function, as determined by the TypeScript compiler.

getCyclomaticComplexity

Gets the cyclomatic complexity of this function.

getEnclosingContainer

Gets the enclosing function or toplevel of this function.

getEnclosingStmt

Gets the statement enclosing this function, if any.

getId

Gets the identifier specifying the name of this function, if any.

getName

Gets the name of this function, if any.

getNumBodyStmt

Gets the number of statements in the body of this function.

getNumberOfLines

Gets the number of lines in this function.

getNumberOfLinesOfCode

Gets the number of lines containing code in this function.

getNumberOfLinesOfComments

Gets the number of lines containing comments in this function.

getParameter

Gets the ith parameter of this function.

getParameterByName

Gets the parameter named name of this function, if any.

getReturnTypeAnnotation

Gets the return type annotation on this function, if any.

getThisBinder

Gets the function whose this binding a this expression in this function refers to, which is the nearest enclosing non-arrow function.

getThisBindingContainer

Gets the function or top-level whose this binding a this expression in this function refers to, which is the nearest enclosing non-arrow function or top-level.

getThisTypeAnnotation

Gets the type annotation for the special this parameter, if it is present.

getTypeParameter

Gets the nth type parameter declared on this function.

getVariable

Gets the variable holding this function.

hasBody

Holds if this function has a body.

hasMappedArgumentsVariable

Holds if this function has a mapped arguments variable whose indices are aliased with the function’s parameters.

hasRestParameter

Holds if the last parameter of this function is a rest parameter.

hasTrailingComma

Holds if the parameter list of this function has a trailing comma.

isAbstract

Holds if this function is part of an abstract class member.

isAmbient

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

isAsync

Holds if this function is an asynchronous function.

isGenerator

Holds if this function is a generator function.

isNonConstructible

Holds if this function cannot be invoked using new because it is of the given kind.

isStrict

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

usesArgumentsObject

Holds if the body of this function refers to the function’s arguments variable.

Inherited predicates

analyze

Gets type inference results for this element.

from ValueNode
flow

Gets the data flow node associated with this program element.

from ValueNode
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
getAStmt

Gets a statement that belongs to this container.

from StmtContainer
getAToken

Gets a token belonging to this element.

from ASTNode
getATypeParameter

Gets any type parameter declared on this function or type.

from TypeParameterized
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
getDocumentation

Gets the JSDoc comment for this element, if any.

from Documentable
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 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
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 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
getNumParameter

Gets the number of parameters declared by this element.

from Parameterized
getNumTypeParameter

Gets the number of type parameters declared on this function or type.

from TypeParameterized
getParameterVariable

Gets a variable of the given name that is a parameter of this element.

from Parameterized
getParent

Gets the parent node of this node, if any.

from ASTNode
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
hasTypeParameters

Holds if this function or type declares any type parameters.

from TypeParameterized
inExternsFile

Holds if this syntactic entity belongs to an externs file.

from ASTNode
toString

Gets a textual representation of this element.

from Locatable