Namespace: Settings
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / Settings
Namespace: Settings
@kui-shell/core.Settings
Table of contents
Functions
Functions
getOrSetPreference
▸ getOrSetPreference(key, defaultValue): Promise<string>
Parameters
| Name | Type |
|---|---|
key | string |
defaultValue | string | () => string | Promise<string> |
Returns
Promise<string>
Defined in
packages/core/src/core/userdata.ts:187
getPreference
▸ Const getPreference(key): Promise<string>
Get a persisted preference
Parameters
| Name | Type |
|---|---|
key | string |
Returns
Promise<string>
the preference value
Defined in
packages/core/src/core/userdata.ts:166
setPreference
▸ Const setPreference(key, value): Promise<string>
Set a persisted preference
Parameters
| Name | Type |
|---|---|
key | string |
value | string |
Returns
Promise<string>
the preference value
Defined in
packages/core/src/core/userdata.ts:179
uiThemes
▸ uiThemes(): Promise<ThemeSet[]>
Returns
Promise<ThemeSet[]>
Defined in
packages/core/src/core/settings.ts:21
userDataDir
▸ Const userDataDir(): string
Get the userdata directory
Returns
string