Class ComponentsDataWrapper

ReadonlyconsensusNodes

ReadonlyenvoyProxies

ReadonlyhaProxies

ReadonlymirrorNodeExplorers

ReadonlymirrorNodes

Readonlyrelays

add

• add(component: BaseComponent): void

  Used to add new component to their respective group.

  Parameters

  • component: BaseComponent

  Returns void

clone

• clone(): ComponentsDataWrapper

  Returns ComponentsDataWrapper

edit

• edit(component: BaseComponent): void

  Used to edit an existing component from their respective group.

  Parameters

  • component: BaseComponent

  Returns void

getComponent

• getComponent<T extends BaseComponent>(
      type: ComponentType,
      serviceName: string,
  ): T

  Type Parameters

  • T extends BaseComponent

  Parameters

  • type: ComponentType
  • serviceName: string

  Returns T

remove

• remove(serviceName: string, type: ComponentType): void

  Used to remove specific component from their respective group.

  Parameters

  • serviceName: string
  • type: ComponentType

  Returns void

toObject

• toObject(): ComponentsDataStructure

  Converts the class instance to a plain object.

  Returns ComponentsDataStructure

  the plain object representation of the class.

validate

• validate(): void

  Validates all properties of the class and throws if data is invalid

  Returns void

StaticfromObject

• fromObject(components: ComponentsDataStructure): ComponentsDataWrapper

  Handles creating instance of the class from plain object.

  Parameters

  • components: ComponentsDataStructure

    component groups distinguished by their type.

  Returns ComponentsDataWrapper

StaticinitializeEmpty

• initializeEmpty(): ComponentsDataWrapper

  Used to create an empty instance used to keep the constructor private

  Returns ComponentsDataWrapper

StaticinitializeWithNodes

• initializeWithNodes(
      nodeAliases: NodeAliases,
      clusterReference: string,
      namespace: string,
  ): ComponentsDataWrapper

  Parameters

  • nodeAliases: NodeAliases
  • clusterReference: string
  • namespace: string

  Returns ComponentsDataWrapper