Class ModifierDefinition

Hierarchy (view full)

Constructors

Properties

context?: ASTContext

Current tree context of the node

documentation?: string | StructuredDocumentation

Optional documentation appearing above the modifier 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: number

Unique identifier number for the node in the tree context

name: string

Modifier name

nameLocation?: string

The source range for name string

parent?: ASTNode

The AST node that is containing current node

raw?: any

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

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.

vBody?: Block

Modifier body

vOverrideSpecifier?: OverrideSpecifier

Override specifier if provided

vParameters: ParameterList

Modifier parameters are local variables within modifier body

virtual: boolean

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

Is false otherwise.

visibility: string

Declaration visibility

Accessors

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

    Returns undefined | ASTNode

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

    Returns undefined | ASTNode

  • 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

  • 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

  • get type(): string
  • Type of the AST node

    Returns string

Methods

  • 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

  • Returns string representation of the node properties.

    Parameters

    • depth: number = 0

      The number of children node levels to output

    Returns string

Generated using TypeDoc