Skeudenn / hooks/use-settings / useSettings

Function: useSettings()

useSettings(): object

Defined in: src/hooks/use-settings.ts:77

The app settings, shared by every component, and the function that changes one.

Returns

settings

settings: PublicSettings

update

update: <K>(key, value) => void

Updates one setting in every view immediately and persists it in the background.

Type Parameters

K

K extends "language" | "pageSpacing" | "theme" | "readerBackground" | "homeEnabled" | "statsEnabled" | "achievementsEnabled" | "askUserOnStartup" | "resyncOnStartup" | "trashAutoEmpty" | "trashRetentionDays" | "backupKeep" | "readingDirection" | "addOpenedBooksToLibrary" | "libraryView" | "readingListView" | "libraryGroupBySeries" | "librarySort" | "homeSections" | "sidebarCollapsed" | "scrollDirection" | "readingMode" | "comicVineEnabled" | "googleBooksEnabled" | "bedethequeSearchByDefault" | "checkUpdatesOnStartup" | "backupIntervalDays" | "lastBackupAt" | "lastResyncAt" | "libraryOrganization" | "libraryOrganizationFolder" | "libraryStructure" | "libraryFileName" | "libraryVolumePrefix" | "libraryVolumePrefixNumericOnly" | "libraryIgnoreArticles" | "libraryArticles" | "librarySidecarCovers" | "libraryWriteNfo" | "fileNameRules" | "lookupRuleCollapsed" | "ignoredDuplicates" | "lastScanFolder"

Parameters

key

K

value

AppSettings[K] & PublicSettings[K]

Returns

void