Class BaseComponent`Abstract`

Represents the base structure and common functionality for all components within the system. This class provides validation, comparison, and serialization functionality for components.

Hierarchy (View Summary)

BaseComponent

Implements

Index

Constructors

`Protected`constructor

new BaseComponent(
    type: ComponentType,
    name: string,
    cluster: string,
    namespace: string,
): BaseComponent
Parameters
- type: ComponentType
  type for identifying.
- name: string
  the name to distinguish components.
- cluster: string
  the cluster in which the component is deployed.
- namespace: string
  the namespace associated with the component.
Returns BaseComponent
- Defined in solo/solo/src/core/config/remote/components/base_component.ts:33

Properties

`Readonly`cluster

cluster: string

the cluster in which the component is deployed.

`Readonly`name

name: string

the name to distinguish components.

`Readonly`namespace

namespace: string

the namespace associated with the component.

`Readonly`type

type: ComponentType

type for identifying.

Methods

toObject

toObject(): Component
Converts the class instance to a plain object.

Returns Component
the plain object representation of the class.
Implementation of ToObject.toObject
- Defined in solo/solo/src/core/config/remote/components/base_component.ts:71

validate

validate(): void
Validates all properties of the class and throws if data is invalid

Returns void
Implementation of Validate.validate
- Defined in solo/solo/src/core/config/remote/components/base_component.ts:53

`Static`compare

compare(x: BaseComponent, y: BaseComponent): boolean
Compares two BaseComponent instances for equality.
Parameters
- x: BaseComponent
  The first component to compare
- y: BaseComponent
  The second component to compare
Returns boolean
boolean - true if the components are equal
- Defined in solo/solo/src/core/config/remote/components/base_component.ts:49

Class BaseComponent`Abstract`

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

`Protected`constructor

Parameters

Returns BaseComponent

Properties

`Readonly`cluster

`Readonly`name

`Readonly`namespace

`Readonly`type

Methods

toObject

Returns Component

validate

Returns void

`Static`compare

Parameters

Returns boolean

Settings

On This Page

Class BaseComponentAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns BaseComponent

Properties

Readonlycluster

Readonlyname

Readonlynamespace

Readonlytype

Methods

toObject

Returns Component

validate

Returns void

Staticcompare

Parameters

Returns boolean

Settings

On This Page

Class BaseComponent`Abstract`

`Protected`constructor

`Readonly`cluster

`Readonly`name

`Readonly`namespace

`Readonly`type

`Static`compare