Class LocalConfig

Index

Constructors

Accessors

clusterRefs deployments soloVersion userEmailAddress

Methods

configFileExists create modify

Constructors

constructor

new LocalConfig(filePath?: string, logger?: SoloLogger): LocalConfig
Parameters
- OptionalfilePath: string
- Optionallogger: SoloLogger
Returns LocalConfig
- Defined in src/core/config/local/local-config.ts:20

Accessors

clusterRefs

get clusterRefs(): Readonly<ClusterReferences>
Returns Readonly<ClusterReferences>
the cluster refs mapping from the local config data if it's loaded

Throws
SoloError if the config is not loaded
- Defined in src/core/config/local/local-config.ts:88

deployments

get deployments(): Readonly<Deployments>
Returns Readonly<Deployments>
the deployment mapping from the local config data if it's loaded

Throws
SoloError if the config is not loaded
- Defined in src/core/config/local/local-config.ts:77

soloVersion

get soloVersion(): string
Returns string
the solo version from the local config data if it's loaded

Throws
SoloError if the config is not loaded
- Defined in src/core/config/local/local-config.ts:66

userEmailAddress

get userEmailAddress(): `${string}@${string}.${string}`
Returns `${string}@${string}.${string}`
the email address from the local config data if it's loaded

Throws
SoloError if the config is not loaded
- Defined in src/core/config/local/local-config.ts:55

Methods

configFileExists

configFileExists(): boolean
Checks if the local config exists at the specified file path

Returns boolean
- Defined in src/core/config/local/local-config.ts:118

create

create(
email: `${string}@${string}.${string}`,
soloVersion: string,
): Promise<void>
Creates new instance of the local config, after validation writes it to the specified file path.
Parameters
- email: `${string}@${string}.${string}`
  the user identification
- soloVersion: string
  the current solo version
Returns Promise<void>
- Defined in src/core/config/local/local-config.ts:144

modify

modify(
callback: (config: LocalConfigDataWrapper) => Promise<void>,
): Promise<void>
Method is used to apply changes to the local config, use the callback to modify the underlying values. Handles checking prerequisites, validation and writing the file.
Parameters
- callback: (config: LocalConfigDataWrapper) => Promise<void>
  callback function containing inside of the the data wrapper.
Returns Promise<void>
Throws
SoloError if the local config is not loaded prior to modifying.
- Defined in src/core/config/local/local-config.ts:103