Class FunctionDefinition

Hierarchy (view full)

Constructors

constructor

Properties

context? documentation? id implemented isConstructor kind name nameLocation? parent? raw? scope src stateMutability vBody? vModifiers vOverrideSpecifier? vParameters vReturnParameters virtual visibility

Accessors

children firstChild lastChild nextSibling previousSibling requiredContext root sourceInfo type vScope

Methods

acceptChildren extractSourceFragment getChildren getChildrenBySelector getChildrenByType getChildrenByTypeString getClosestParentBySelector getClosestParentByType getClosestParentByTypeString getFieldValues getGettersValues getParents getParentsBySelector print walk walkChildren walkParents

Constructors

constructor

Properties

Optional context

context?: ASTContext

Current tree context of the node

Optional documentation

documentation?: string | StructuredDocumentation

Optional documentation appearing above the function definition:

  • Is undefined when not specified.
  • Is type of string when specified and compiler version is older than 0.6.3.
  • Is instance of StructuredDocumentation when specified and compiler version is 0.6.3 or newer.

id

id: number

Unique identifier number for the node in the tree context

implemented

implemented: boolean

Is false if the function not have an implementation and true if it is implemented in place.

isConstructor

isConstructor: boolean

Set if it is a constructor

kind

kind: FunctionKind

A kind of a function definition

name

name: string

Identifier of the function

Optional nameLocation

nameLocation?: string

The source range for name string

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.

scope

scope: number

Node id of scoped contract or source unit

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.

stateMutability

stateMutability: FunctionStateMutability

Function state mutability, that is non-payable, payable, pure or view. Deprecated constant is only allowed in 0.4.x

Optional vBody

vBody?: Block

Function body block: can be empty if function is declared, but not implemented. Always filled otherwise.

vModifiers

vModifiers: ModifierInvocation[]

Invoked modifiers

Optional vOverrideSpecifier

vOverrideSpecifier?: OverrideSpecifier

Override specifier if provided

vParameters

vParameters: ParameterList

A list of local variables that are declared and initialized with the input values

vReturnParameters

vReturnParameters: ParameterList

A list of local variables that are declared and returned to the caller

virtual

virtual: boolean

Is true if function is declared as possibly overridable (using virtual keyword since Solidity 0.6).

Is false otherwise.

visibility

visibility: FunctionVisibility

Function visibility, for example: public, internal, private or external.

Accessors

children

firstChild

  • get firstChild(): undefined | ASTNode

  • Returns the first immediate child of the node, or undefined if the node has no children.

    Returns undefined | ASTNode

lastChild

  • get lastChild(): undefined | ASTNode

  • Returns the last immediate child of the node, or undefined if the node has no children.

    Returns undefined | ASTNode

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

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

requiredContext

root

sourceInfo

type

  • get type(): string

  • Type of the AST node

    Returns string

vScope

Methods

acceptChildren

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

getChildren

getChildrenBySelector

getChildrenByType

getChildrenByTypeString

getClosestParentBySelector

getClosestParentByType

getClosestParentByTypeString

getFieldValues

getGettersValues

getParents

getParentsBySelector

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

walk

walkChildren

walkParents

Settings

Member Visibility

Theme

On This Page

constructorcontextdocumentationidimplementedisConstructorkindnamenameLocationparentrawscopesrcstateMutabilityvBodyvModifiersvOverrideSpecifiervParametersvReturnParametersvirtualvisibilitychildrenfirstChildlastChildnextSiblingpreviousSiblingrequiredContextrootsourceInfotypevScopeacceptChildrenextractSourceFragmentgetChildrengetChildrenBySelectorgetChildrenByTypegetChildrenByTypeStringgetClosestParentBySelectorgetClosestParentByTypegetClosestParentByTypeStringgetFieldValuesgetGettersValuesgetParentsgetParentsBySelectorprintwalkwalkChildrenwalkParents

Generated using TypeDoc