Class Settings

Class that handles setting/getting settings and can save them to a local file

Hierarchy

Settings

Index

Methods

Methods

Static getHidden

getHidden(id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl"): any

- Defined in modules/Settings/API/Settings.js:13
Get value of a hidden setting

Parameters
- id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl"
  
  Unique id
Returns any

The value

Static getModifiable

getModifiable(id: "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"): any

- Defined in modules/Settings/API/Settings.js:21
Get value of a modifiable setting

Parameters
- id: "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"
  
  Unique id
Returns any

The value

Static getModifiableDefault

getModifiableDefault(id: "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"): any

- Defined in modules/Settings/API/Settings.js:29
Get the default value of a modifiable setting

Parameters
- id: "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"
  
  Unique id
Returns any

The default value

Static getModifiableSetting

getModifiableSetting(settingId: string): SettingsObjectMerged

- Defined in modules/Settings/API/Settings.js:61
Get all modifiable settings merged with the local values

Parameters
- settingId: string
Returns SettingsObjectMerged

Static getModifiableSettings

getModifiableSettings(): string[]

- Defined in modules/Settings/API/Settings.js:52
Get all modifiable settings merged with the local values

Returns string[]

Static makeModifiableTypeChecks

makeModifiableTypeChecks(type: "password" | "toggle" | "text" | "cronJob" | "url" | "keyboardShortcut", value: any): void

- Defined in modules/Settings/API/Settings.js:78
Type check a setting

Parameters
- type: "password" | "toggle" | "text" | "cronJob" | "url" | "keyboardShortcut"
- value: any
Returns void

Static save

save(): void

- Defined in modules/Settings/API/Settings.js:70
Save settings in local file

Returns void

Static setHidden

setHidden(id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl", value: any): void

- Defined in modules/Settings/API/Settings.js:37
Set hidden setting with id and value

Parameters
- id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl"
- value: any
Returns void

Static setModifiable

setModifiable(id: "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow", value: any): void

- Defined in modules/Settings/API/Settings.js:45
Set modifiable setting with id and value

Parameters
- id: "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"
- value: any
Returns void

Generated using TypeDoc