ConfigStore | @salesforce/core

An interface for a config object with a persistent store.

interface

Hierarchy

ConfigStore

Implemented by

Index

Methods

Methods

awaitEach

awaitEach(actionFn: function): Promise<void>

- Defined in config/configStore.ts:67
Parameters
- actionFn: function
  - - (key: string, value: ConfigValue): Promise<void>
    - Parameters
      - key: string
      - value: ConfigValue
      Returns Promise<void>
Returns Promise<void>

clear

clear(): void

- Defined in config/configStore.ts:63
Returns void

entries

entries(): ConfigEntry[]

- Defined in config/configStore.ts:55
Returns ConfigEntry[]

forEach

forEach(actionFn: function): void

- Defined in config/configStore.ts:66
Parameters
- actionFn: function
  - - (key: string, value: ConfigValue): void
    - Parameters
      - key: string
      - value: ConfigValue
      Returns void
Returns void

get

get(key: string): Optional<ConfigValue>

- Defined in config/configStore.ts:56
Parameters
- key: string
Returns Optional<ConfigValue>

getContents

getContents(): ConfigContents

- Defined in config/configStore.ts:72
Returns ConfigContents

getKeysByValue

getKeysByValue(value: ConfigValue): string[]

- Defined in config/configStore.ts:57
Parameters
- value: ConfigValue
Returns string[]

has

has(key: string): boolean

- Defined in config/configStore.ts:58
Parameters
- key: string
Returns boolean

keys

keys(): string[]

- Defined in config/configStore.ts:59
Returns string[]

set

set(key: string, value: ConfigValue): ConfigContents

- Defined in config/configStore.ts:60
Parameters
- key: string
- value: ConfigValue
Returns ConfigContents

setContents

setContents(contents?: ConfigContents): void

- Defined in config/configStore.ts:73
Parameters
- Optional contents: ConfigContents
Returns void

unset

unset(key: string): boolean

- Defined in config/configStore.ts:61
Parameters
- key: string
Returns boolean

unsetAll

unsetAll(keys: string[]): boolean

- Defined in config/configStore.ts:62
Parameters
- keys: string[]
Returns boolean

values

values(): ConfigValue[]

- Defined in config/configStore.ts:64
Returns ConfigValue[]