Class IBMConfigManager

Filesystem-enabled IBM Quantum configuration manager. Manages IBM Quantum Platform configuration files.

Hierarchy (View Summary)

FsConfigManager<IBMConfigData>
- IBMConfigManager

Index

Constructors

Properties

config configPath

Methods

ensureConfigFileExists getApiKey getBearerToken getConfig getDefaultConfig getServiceCRN isBearerTokenExpired loadConfig parseConfig saveConfig setApiKey setBearerToken setServiceCRN stringifyConfig

Constructors

constructor

new IBMConfigManager(filePath?: string): IBMConfigManager
Parameters
- OptionalfilePath: string
Returns IBMConfigManager
Overrides FsConfigManager.constructor
- Defined in fs/src/ibm-config.ts:22

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/ibm-config.ts:50

getBearerToken

getBearerToken(): string
Returns string
- Defined in fs/src/ibm-config.ts:66

getConfig

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

`Protected`getDefaultConfig

getDefaultConfig(): IBMConfigData
Returns IBMConfigData
Overrides FsConfigManager.getDefaultConfig
- Defined in fs/src/ibm-config.ts:34

getServiceCRN

getServiceCRN(): string
Returns string
- Defined in fs/src/ibm-config.ts:58

isBearerTokenExpired

isBearerTokenExpired(): boolean
Returns boolean
- Defined in fs/src/ibm-config.ts:75

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): IBMConfigData
Parameters
- content: string
Returns IBMConfigData
Overrides FsConfigManager.parseConfig
- Defined in fs/src/ibm-config.ts:26

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/ibm-config.ts:54

setBearerToken

setBearerToken(token: string): void
Parameters
- token: string
Returns void
- Defined in fs/src/ibm-config.ts:70

setServiceCRN

setServiceCRN(crn: string): void
Parameters
- crn: string
Returns void
- Defined in fs/src/ibm-config.ts:62

`Protected`stringifyConfig

stringifyConfig(config: IBMConfigData): string
Parameters
- config: IBMConfigData
Returns string
Overrides FsConfigManager.stringifyConfig
- Defined in fs/src/ibm-config.ts:30