Class ReturnStmt

A return statement.

Examples:

return -1;
return;

Import path

import javascript

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    getExpr

    Gets the expression specifying the returned value, if any.

    getFirstControlFlowNode

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

    getTarget

    Gets the target of this return statement, which is the enclosing statement container.

    isSubjectToSemicolonInsertion

    Holds if automatic semicolon insertion applies to this 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
    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
    getBasicBlock

    Gets the basic block this node belongs to.

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

    Gets the first token belonging to this element.

    from ASTNode
    getKind

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

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

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

    from Stmt
    getStartLine

    Gets the line on which this element starts.

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