Class Return

Hierarchy (view full)

Statement
- Return

Constructors

constructor

new Return(id, src, functionReturnParameters, expression?, documentation?, raw?): Return
Parameters
- id: number
- src: string
- functionReturnParameters: number
- Optional expression: Expression
- Optional documentation: string | StructuredDocumentation
- Optional raw: any
Returns Return
Overrides Statement.constructor
- Defined in src/ast/implementation/statement/return.ts:18

Properties

`Optional` context

context?: ASTContext

Current tree context of the node

`Optional` documentation

documentation?: string | StructuredDocumentation

Optional documentation appearing above the statement:

Is undefined when not specified.
Is type of string for compatibility reasons.

functionReturnParameters

functionReturnParameters: number

Id of the parameter list that specifies the return parameters

id

id: number

Unique identifier number for the node in the tree context

`Optional` parent

parent?: ASTNode

The AST node that is containing current node

`Optional` raw

raw?: any

Raw original Solc AST node that was used to create current node.

src

src: string

Source mapping data corresponting to the AST node.

The value has format start:length:sourceIndex:

start is the starting index of the corresponding code fragment substring in the source string;
length is the length of corresponding code fragment substring;
sourceIndex is the index number of the source unit (file), that contains the AST node.

To get parsed values, use sourceInfo accessor.

`Optional` vExpression

vExpression?: Expression

Expression that is returned (if specified)

Accessors

children

get children(): readonly ASTNode[]
Returns children nodes of the current node

Returns readonly ASTNode[]
Overrides Statement.children
- Defined in src/ast/implementation/statement/return.ts:35

firstChild

get firstChild(): undefined | ASTNode
Returns the first immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
Inherited from Statement.firstChild
- Defined in src/ast/ast_node.ts:105

lastChild

get lastChild(): undefined | ASTNode
Returns the last immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
Inherited from Statement.lastChild
- Defined in src/ast/ast_node.ts:113

nextSibling

get nextSibling(): undefined | ASTNode
Returns the node immediately following the current one in its parent's children.

Returns undefined if the current node is the last child in its parent's children.

Returns undefined | ASTNode
Inherited from Statement.nextSibling
- Defined in src/ast/ast_node.ts:142

previousSibling

get previousSibling(): undefined | ASTNode
Returns the node immediately preceding the current one in its parent's children.

Returns undefined if the current node is the first child in its parent's children.

Returns undefined | ASTNode
Inherited from Statement.previousSibling
- Defined in src/ast/ast_node.ts:124

requiredContext

get requiredContext(): ASTContext
Returns current node AST context. Throws an error if no context is set.

Returns ASTContext
Inherited from Statement.requiredContext
- Defined in src/ast/ast_node.ts:86

root

get root(): ASTNode
Returns most parent node in tree hierarchy

Returns ASTNode
Inherited from Statement.root
- Defined in src/ast/ast_node.ts:156

sourceInfo

get sourceInfo(): SourceLocation
Returns parsed parts of the src property value

Returns SourceLocation
Inherited from Statement.sourceInfo
- Defined in src/ast/ast_node.ts:169

type

get type(): string
Type of the AST node

Returns string
Inherited from Statement.type
- Defined in src/ast/ast_node.ts:79

vFunctionReturnParameters

get vFunctionReturnParameters(): ParameterList
The parameter list that specifies the return parameters

Returns ParameterList
- Defined in src/ast/implementation/statement/return.ts:42
set vFunctionReturnParameters(value): void
Parameters
- value: ParameterList
Returns void
- Defined in src/ast/implementation/statement/return.ts:46

Methods

acceptChildren

acceptChildren(): void
Sets parent to the current node for each of the accessible children node.

Returns void
Inherited from Statement.acceptChildren
- Defined in src/ast/ast_node.ts:70

extractSourceFragment

extractSourceFragment(source): Uint8Array
Extracts and returns substring from source, that corresponds to src property value of the current node.

In other words, returns corresponding code fragment substring.
Parameters
- source: Uint8Array
Returns Uint8Array
Inherited from Statement.extractSourceFragment
- Defined in src/ast/ast_node.ts:331

getChildren

getChildren(inclusive?): ASTNode[]
Parameters
- inclusive: boolean = false
Returns ASTNode[]
Inherited from Statement.getChildren
- Defined in src/ast/ast_node.ts:197

getChildrenBySelector

getChildrenBySelector<T>(selector, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
- inclusive: boolean = true
Returns T[]
Inherited from Statement.getChildrenBySelector
- Defined in src/ast/ast_node.ts:212

getChildrenByType

getChildrenByType<T>(type, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
- inclusive: boolean = false
Returns T[]
Inherited from Statement.getChildrenByType
- Defined in src/ast/ast_node.ts:229

getChildrenByTypeString

getChildrenByTypeString<T>(typeString, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
- inclusive: boolean = false
Returns T[]
Inherited from Statement.getChildrenByTypeString
- Defined in src/ast/ast_node.ts:233

getClosestParentBySelector

getClosestParentBySelector<T>(selector): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns undefined | T
Inherited from Statement.getClosestParentBySelector
- Defined in src/ast/ast_node.ts:247

getClosestParentByType

getClosestParentByType<T>(type): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
Returns undefined | T
Inherited from Statement.getClosestParentByType
- Defined in src/ast/ast_node.ts:261

getClosestParentByTypeString

getClosestParentByTypeString<T>(typeString): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
Returns undefined | T
Inherited from Statement.getClosestParentByTypeString
- Defined in src/ast/ast_node.ts:265

getFieldValues

getFieldValues(): Map<string, any>
Returns Map<string, any>
Inherited from Statement.getFieldValues
- Defined in src/ast/ast_node.ts:291

getGettersValues

getGettersValues(): Map<string, any>
Returns Map<string, any>
Inherited from Statement.getGettersValues
- Defined in src/ast/ast_node.ts:295

getParents

getParents(): ASTNode[]
Returns ASTNode[]
Inherited from Statement.getParents
- Defined in src/ast/ast_node.ts:237

getParentsBySelector

getParentsBySelector<T>(selector): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns T[]
Inherited from Statement.getParentsBySelector
- Defined in src/ast/ast_node.ts:269

print

print(depth?): string
Returns string representation of the node properties.
Parameters
- depth: number = 0
  The number of children node levels to output
Returns string
Inherited from Statement.print
- Defined in src/ast/ast_node.ts:287

walk

walk(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from Statement.walk
- Defined in src/ast/ast_node.ts:173

walkChildren

walkChildren(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from Statement.walkChildren
- Defined in src/ast/ast_node.ts:179

walkParents

walkParents(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from Statement.walkParents
- Defined in src/ast/ast_node.ts:187

Class Return

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Return

Properties

Optional context

Optional documentation

functionReturnParameters

id

Optional parent

Optional raw

src

Optional vExpression

Accessors

children

Returns readonly ASTNode[]

firstChild

Returns undefined | ASTNode

lastChild

Returns undefined | ASTNode

nextSibling

Returns undefined | ASTNode

previousSibling

Returns undefined | ASTNode

requiredContext

Returns ASTContext

root

Returns ASTNode

sourceInfo

Returns SourceLocation

type

Returns string

vFunctionReturnParameters

Returns ParameterList

Parameters

Returns void

Methods

acceptChildren

Returns void

extractSourceFragment

Parameters

Returns Uint8Array

getChildren

Parameters

Returns ASTNode[]

getChildrenBySelector

Type Parameters

Parameters

Returns T[]

getChildrenByType

Type Parameters

Parameters

Returns T[]

getChildrenByTypeString

Type Parameters

Parameters

Returns T[]

getClosestParentBySelector

Type Parameters

Parameters

Returns undefined | T

getClosestParentByType

Type Parameters

Parameters

Returns undefined | T

getClosestParentByTypeString

Type Parameters

Parameters

Returns undefined | T

getFieldValues

Returns Map<string, any>

getGettersValues

Returns Map<string, any>

`Optional` context

`Optional` documentation

`Optional` parent

`Optional` raw

`Optional` vExpression