Class QbraidConfigManager

Filesystem-enabled qBraid configuration manager. Provides all the functionality of the base QbraidConfigManager plus file I/O operations.

Hierarchy (View Summary)

FsConfigManager<ConfigData>
- QbraidConfigManager

Constructors

constructor

new QbraidConfigManager(filePath?: string): QbraidConfigManager
Parameters
- filePath: string = USER_CONFIG_PATH
Returns QbraidConfigManager
Overrides FsConfigManager.constructor
- Defined in fs/src/config.ts:75

Properties

`Protected`config

config: T

`Protected`configPath

configPath: string

Methods

`Protected`ensureConfigFileExists

ensureConfigFileExists(): void
Returns void
Inherited from FsConfigManager.ensureConfigFileExists
- Defined in fs/src/config.ts:27

getApiKey

getApiKey(): string
Returns string
- Defined in fs/src/config.ts:139

getAuthData

getAuthData(): AuthData
Returns AuthData
- Defined in fs/src/config.ts:171

getConfig

getConfig(): T
Returns T
Inherited from FsConfigManager.getConfig
- Defined in base/dist/src/config.d.ts:22

`Protected`getDefaultConfig

getDefaultConfig(): ConfigData
Returns ConfigData
Overrides FsConfigManager.getDefaultConfig
- Defined in fs/src/config.ts:88

getEmail

getEmail(): string
Returns string
- Defined in fs/src/config.ts:155

getRefreshToken

getRefreshToken(): string
Returns string
- Defined in fs/src/config.ts:147

getSection

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

getUrl

getUrl(): string
Returns string
- Defined in fs/src/config.ts:163

getValue

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

loadConfig

loadConfig(): T
Load configuration. Implementation depends on the storage mechanism.

Returns T
Inherited from FsConfigManager.loadConfig
- Defined in fs/src/config.ts:38

`Protected`parseConfig

parseConfig(content: string): ConfigData
Parameters
- content: string
Returns ConfigData
Overrides FsConfigManager.parseConfig
- Defined in fs/src/config.ts:80

removeSection

removeSection(section: string): void
Parameters
- section: string
Returns void
- Defined in fs/src/config.ts:128

removeValue

removeValue(section: string, key: string): void
Parameters
- section: string
- key: string
Returns void
- Defined in fs/src/config.ts:132

saveConfig

saveConfig(): void
Save configuration. Implementation depends on the storage mechanism.

Returns void
Inherited from FsConfigManager.saveConfig
- Defined in fs/src/config.ts:59

setApiKey

setApiKey(apiKey: string): void
Parameters
- apiKey: string
Returns void
- Defined in fs/src/config.ts:143

setEmail

setEmail(email: string): void
Parameters
- email: string
Returns void
- Defined in fs/src/config.ts:159

setRefreshToken

setRefreshToken(refreshToken: string): void
Parameters
- refreshToken: string
Returns void
- Defined in fs/src/config.ts:151

setUrl

setUrl(url: string): void
Parameters
- url: string
Returns void
- Defined in fs/src/config.ts:167

setValue

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

`Protected`stringifyConfig

stringifyConfig(config: ConfigData): string
Parameters
- config: ConfigData
Returns string
Overrides FsConfigManager.stringifyConfig
- Defined in fs/src/config.ts:84

updateConfig

updateConfig(newConfig: ConfigData): void
Parameters
- newConfig: ConfigData
Returns void
- Defined in fs/src/config.ts:124