Class StructFragment

A Fragment which represents a structure.

Hierarchy

Constructors

constructor

Properties

inputs name type

Methods

format from isConstructor isError isEvent isFragment isFunction isStruct

Constructors

constructor

Properties

Readonly inputs

inputs: readonly ParamType[]

The inputs for the fragment.

Readonly name

name: string

The name of the fragment.

Readonly type

type: FragmentType

The type of the fragment.

Methods

format

  • format(): string

  • Returns a string representation of this struct as %%format%%.

    Returns string

Static from

Static isConstructor

Static isError

  • isError(value): value is ErrorFragment

  • Returns true if %%value%% is an [[ErrorFragment]].

    Parameters

    • value: any

    Returns value is ErrorFragment

Static isEvent

  • isEvent(value): value is EventFragment

  • Returns true if %%value%% is an [[EventFragment]].

    Parameters

    • value: any

    Returns value is EventFragment

Static isFragment

  • isFragment(value): value is FunctionFragment

  • Returns true and provides a type guard if %%value%% is a StructFragment.

    Parameters

    • value: any

    Returns value is FunctionFragment

Static isFunction

Static isStruct

  • isStruct(value): value is StructFragment

  • Returns true if %%value%% is a [[StructFragment]].

    Parameters

    • value: any

    Returns value is StructFragment

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc