Class QbraidConfigManager

Hierarchy (View Summary)

ConfigManager<ConfigData>
- QbraidConfigManager

Constructors

constructor

new QbraidConfigManager(filePath?: string): QbraidConfigManager
Parameters
- filePath: string = USER_CONFIG_PATH
Returns QbraidConfigManager
Overrides ConfigManager.constructor
- Defined in packages/base/src/config.ts:88

Properties

`Protected`config

config: T

`Protected`configPath

configPath: string

Methods

`Protected`ensureConfigFileExists

ensureConfigFileExists(): void
Returns void
Inherited from ConfigManager.ensureConfigFileExists
- Defined in packages/base/src/config.ts:37

getApiKey

getApiKey(): string
Returns string
- Defined in packages/base/src/config.ts:150

getAuthData

getAuthData(): AuthData
Returns AuthData
- Defined in packages/base/src/config.ts:182

getConfig

getConfig(): T
Returns T
Inherited from ConfigManager.getConfig
- Defined in packages/base/src/config.ts:79

`Protected`getDefaultConfig

getDefaultConfig(): ConfigData
Returns ConfigData
Overrides ConfigManager.getDefaultConfig
- Defined in packages/base/src/config.ts:101

getEmail

getEmail(): string
Returns string
- Defined in packages/base/src/config.ts:166

getRefreshToken

getRefreshToken(): string
Returns string
- Defined in packages/base/src/config.ts:158

getSection

getSection(section: string): undefined | Record<string, string>
Parameters
- section: string
Returns undefined | Record<string, string>
- Defined in packages/base/src/config.ts:121

getUrl

getUrl(): string
Returns string
- Defined in packages/base/src/config.ts:174

getValue

getValue(section: string, key: string): undefined | string
Parameters
- section: string
- key: string
Returns undefined | string
- Defined in packages/base/src/config.ts:125

loadConfig

loadConfig(): T
Returns T
Inherited from ConfigManager.loadConfig
- Defined in packages/base/src/config.ts:48

`Protected`parseConfig

parseConfig(content: string): ConfigData
Parameters
- content: string
Returns ConfigData
Overrides ConfigManager.parseConfig
- Defined in packages/base/src/config.ts:93

removeSection

removeSection(section: string): void
Parameters
- section: string
Returns void
- Defined in packages/base/src/config.ts:140

removeValue

removeValue(section: string, key: string): void
Parameters
- section: string
- key: string
Returns void
- Defined in packages/base/src/config.ts:144

saveConfig

saveConfig(): void
Returns void
Inherited from ConfigManager.saveConfig
- Defined in packages/base/src/config.ts:69

setApiKey

setApiKey(apiKey: string): void
Parameters
- apiKey: string
Returns void
- Defined in packages/base/src/config.ts:154

setEmail

setEmail(email: string): void
Parameters
- email: string
Returns void
- Defined in packages/base/src/config.ts:170

setRefreshToken

setRefreshToken(refreshToken: string): void
Parameters
- refreshToken: string
Returns void
- Defined in packages/base/src/config.ts:162

setUrl

setUrl(url: string): void
Parameters
- url: string
Returns void
- Defined in packages/base/src/config.ts:178

setValue

setValue(section: string, key: string, value: string): void
Parameters
- section: string
- key: string
- value: string
Returns void
- Defined in packages/base/src/config.ts:129

`Protected`stringifyConfig

stringifyConfig(config: ConfigData): string
Parameters
- config: ConfigData
Returns string
Overrides ConfigManager.stringifyConfig
- Defined in packages/base/src/config.ts:97

updateConfig

updateConfig(newConfig: ConfigData): void
Parameters
- newConfig: ConfigData
Returns void
- Defined in packages/base/src/config.ts:136