Skip to content

Main Navigation Guide Architecture Reference

Appearance

Sidebar Navigation

Guide

Features

Contributors

Development

Architecture

Decision records

Reference (generated)

IPC channels

Database schema

TypeScript API

hooks

use-achievements

Functions

useAchievements

useAchievementStats

useAchievementTracker

useOpeningAchievements

use-comic

Interfaces

UseComicOptions

Functions

useComic

use-fullscreen

Functions

useFullscreen

use-image-scan

Functions

useImageScan

use-image-upscaler

Interfaces

ImageUpscalerResult

Functions

useImageUpscaler

use-launch-file

Functions

useLaunchFile

use-library

Functions

useLibrary

use-library-rows

Interfaces

LibraryRows

Functions

useLibraryRows

use-library-selection

Interfaces

LibrarySelection

Functions

useLibrarySelection

use-next-in-list

Interfaces

NextInList

Functions

useNextInList

use-organization-offer

Functions

useOrganizationOffer

use-reader-fullscreen

Interfaces

ReaderFullscreen

Functions

useReaderFullscreen

use-reading-lists

Functions

useReadingLists

use-reading-pace

Interfaces

ReadingPace

Functions

formatRemainingTime

useReadingPace

use-reading-time

Functions

useReadingTime

use-resume-scroll

Functions

useResumeScroll

use-scan-progress

Functions

useScanProgress

use-scroll-to-top-on-navigation

Functions

useScrollToTopOnNavigation

use-settings

Functions

applyInterfaceLanguage

keepInterfaceLanguageInSync

keepThemeInSync

loadSystemLanguages

systemLanguage

useSettings

use-settled-value

Functions

useSettledValue

use-users

Functions

useActiveUser

useUsers

lib

achievements

Interfaces

AchievementRule

AchievementStats

OpeningContext

Variables

ACHIEVEMENT_RULES

Functions

achievementProgress

computeStats

earnedFromStats

eventAchievements

app-data

Variables

appData

avatar

Functions

shrinkAvatar

squareCrop

book-bulk-edit

Interfaces

BulkCurrent

BulkForm

Type Aliases

BulkField

CurrentValue

Variables

BULK_FIELDS

Functions

bulkCurrent

bulkToUpdate

emptyBulkForm

validateBulkForm

book-edit

Interfaces

BookForm

CreditRow

Type Aliases

BookFormErrors

BookFormField

Variables

BOOK_LANGUAGES

Functions

entryToForm

formToUpdate

isValidForm

newCreditRow

validateForm

book-tooltip

Functions

bookTooltip

fileBaseName

continue-reading

Variables

CONTINUE_READING_COUNT

Functions

continueReading

cover-crop

Interfaces

SourceRect

Variables

COVER_OUTPUT_HEIGHT

COVER_OUTPUT_WIDTH

MAX_COVER_ZOOM

Functions

coverSourceRect

cropToCover

cover-queue

Interfaces

TaskQueue

Functions

createTaskQueue

cover-revisions

Functions

bumpCoverRevision

coverRevision

subscribeCoverRevisions

data-store

Classes

DataStore

Interfaces

DataSource

Type Aliases

DataSlice

Functions

applyLibraryChange

home-favorites

Variables

FAVORITE_MIN_RATING

FAVORITES_COUNT

Functions

pickRandomFavorites

topRated

home-picks

Variables

HOME_PICK_COUNT

Functions

pickRandomUnread

sampleRandom

home-sections

Type Aliases

ResolvedHomeSection

Functions

clampHomeCount

moveHomeSection

resolveHomeSections

setHomeSectionOptions

setHomeSectionVisible

visibleHomeSections

image-scan

Functions

formatPageSize

imageScanPercent

language-flag

Functions

languageCountry

library-editions

Functions

collapseEditions

duplicateGroupKey

duplicateGroups

editionGroups

editionKey

rememberIgnoredGroups

library-filter

Interfaces

LibraryFilters

Type Aliases

RatingFilter

Variables

EMPTY_FILTERS

Functions

availableLanguages

availableTags

filterEntries

hasActiveFilters

hasFiche

library-filters-memory

Functions

rememberedFilters

rememberFilters

library-groups

Interfaces

CardsRow

EntryRow

SeriesHeaderRow

Type Aliases

LibraryLine

LibraryRow

Variables

NO_SERIES_KEY

Functions

gridLines

groupBySeries

seriesKey

ungroupedRows

library-selection

Functions

draggedEntries

selectedEntries

toggleSelection

library-sort

Functions

sortEntries

library-structure

Functions

fileNameExample

levelChoices

setLevel

structureExample

lookup-query

Functions

fileStem

forgetRule

initialLookupQuery

initialRuleState

offeredRules

queryFromParsedName

queryFromRule

rememberRule

lru-cache

Interfaces

LruCache

Functions

createLruCache

metadata-lookup

Interfaces

LookupState

Type Aliases

LookupAction

LookupStep

Variables

INITIAL_LOOKUP

Functions

lookupReducer

metadata-review

Interfaces

CreditReview

FieldReview

MetadataReview

Type Aliases

ReviewField

Variables

REVIEW_FIELDS

Functions

buildReview

creditRoleLabel

isEmptyUpdate

reviewFieldLabel

reviewToUpdate

reader-navigation

Interfaces

DirectionalControls

PageTurnKeyEvent

Functions

directionalControls

disabledControls

pageTurnForKey

scrollEdgeAfterTurn

reading-list

Interfaces

BulkAddRequest

DraggedEntry

DropFeedback

ListProgress

Variables

LIBRARY_ENTRY_DRAG_TYPE

QUICK_TAGS

TO_READ_TAG

Functions

bulkAddFeedback

bulkAddRequest

decodeDraggedEntries

dropFeedback

encodeDraggedEntries

isFinished

listEntries

listProgress

moveItem

moveUnfinished

nextToRead

seriesEntries

seriesKey

sortByVolume

tagLabel

toggleTag

reading-stats

Interfaces

LibraryGrowthPoint

LibraryTotals

StatsBucket

Type Aliases

StatsPeriod

Variables

MONTHS_SHOWN

WEEKS_SHOWN

Functions

buildBuckets

buildLibraryGrowth

formatDuration

libraryTotals

periodKey

periodLabel

totalSeconds

reading-time

Interfaces

ReadingTimeAccumulator

Variables

FLUSH_AFTER_SECONDS

Functions

createReadingTimeAccumulator

recent-books

Variables

RECENT_BOOKS_COUNT

Functions

recentlyAdded

recovery-guard

Interfaces

RecoveryGuard

Functions

createRecoveryGuard

second-chance

Variables

LOW_RATING_MAX

SECOND_CHANCE_LIMIT

Functions

lowestRated

pickRandomLowRated

settings-nav

Interfaces

SettingsGroup

SettingsSection

Variables

SETTINGS_GROUPS

Functions

isOrganizationOn

visibleSections

theme

Functions

isDarkTheme

trailing-debounce

Interfaces

TrailingDebounce

Functions

createTrailingDebounce

user-choice

Functions

markUserChoiceDone

userChoiceDone

utils

Functions

cn

formatFileSize

formatLanguage

wheel-pager

Functions

createWheelPager

main

db

achievement-repository

Classes

backup-runner

Classes

Interfaces

Type Aliases

Functions

backup-service

Variables

Functions

backup-worker

clear-library

Interfaces

Functions

database

Functions

db-location

Variables

Functions

export-service

Interfaces

Functions

import-service

Variables

Functions

library-folder-repository

Classes

library-repository

Classes

path-roots

Classes

Interfaces

Variables

Functions

people-repository

Classes

Interfaces

reading-list-repository

Classes

schema

Variables

Functions

settings-repository

Classes

stats-repository

Classes

Functions

transaction

Functions

user-repository

Classes

decoder

protocol

Interfaces

Type Aliases

services

bedetheque

Interfaces

Type Aliases

Functions

cbr-archive

Classes

Functions

cbr-conversion

Interfaces

Functions

cbr-converter

Interfaces

Functions

cbz-archive

Classes

Functions

cbz-cleaner

Interfaces

Functions

cloud-files

Type Aliases

Variables

Functions

comic-archive

Interfaces

Variables

Functions

comic-service

Classes

Variables

Functions

comic-vine

Classes

Functions

cover-sidecar

Variables

Functions

folder-cleanup

Interfaces

Functions

google-books

Classes

Interfaces

Functions

http-json

Interfaces

Variables

Functions

image-size

Interfaces

Variables

Functions

image-stats

Functions

image-stats-scanner

Interfaces

Functions

library-cleanup

Interfaces

Functions

library-organization

Interfaces

Type Aliases

Variables

Functions

library-organizer

Interfaces

Type Aliases

Variables

Functions

library-scanner

Interfaces

Functions

library-sync

Interfaces

Functions

lookup-log

Functions

metadata-service

Type Aliases

Functions

nfo

Variables

Functions

open-error

Functions

organized-folder

Functions

pdf-archive

Classes

Variables

Functions

promise-cache

Interfaces

Functions

rar-fixture

Functions

request-pacer

Interfaces

Functions

sidecars

Functions

structured-page

Functions

thumbnail-cache

Classes

Variables

Functions

update-checker

Variables

Functions

preload

Interfaces

AchievementsApi

AppApi

ComicApi

DataApi

DatabaseApi

LibraryApi

MetadataApi

ReadingListApi

SettingsApi

StatsApi

TankobonApi

UsersApi

shared

achievements

Interfaces

UnlockedAchievement

Type Aliases

AchievementGroup

AchievementId

Variables

ACHIEVEMENT_GROUPS

ACHIEVEMENT_IDS

Functions

isAchievementId

app

Interfaces

AppInfo

Type Aliases

AppLink

UpdateCheckResult

Variables

APP_LINKS

Functions

formatAppInfo

isAppLink

isNewerVersion

parseVersion

articles

Variables

DEFAULT_ARTICLES

MAX_ARTICLE_LENGTH

MAX_ARTICLES

Functions

formatArticleList

isArticle

isArticleList

moveArticleToEnd

parseArticleList

comic

Interfaces

ArchiveInfo

ComicInfo

ComicPage

Type Aliases

ComicFormat

OpenComicResult

Variables

SUPPORTED_COMIC_EXTENSIONS

Functions

comicFormat

isSupportedComicFile

data

Interfaces

BackupInfo

BackupList

DatabaseLocation

Type Aliases

BackupResult

ClearCacheResult

ClearLibraryResult

DatabaseLocationResult

ExportResult

ImportResult

RestoreBackupResult

data-changes

Interfaces

AchievementsChange

LibraryChange

ReadingListsChange

SettingsChange

UsersChange

Type Aliases

DataChange

file-name-template

Type Aliases

FileNameField

ParsedFileName

Variables

FILE_NAME_FIELDS

MAX_FILE_NAME_TEMPLATE_LENGTH

MAX_VOLUME_PADDING

MAX_VOLUME_PREFIX_LENGTH

Functions

fileNameTemplateError

fillFileNameTemplate

isFileNameTemplate

isVolumePrefix

padVolume

parseFileName

prefixVolume

i18n

Type Aliases

Language

LanguageSetting

Variables

FALLBACK_LANGUAGE

i18n

LANGUAGE_NAMES

SUPPORTED_LANGUAGES

t

Functions

applyLanguage

currentLanguage

isSupportedLanguage

resolveLanguage

library

Interfaces

CleanupGroup

Credit

CreditInput

ImageScanProgress

LibraryEntry

MetadataUpdate

OrganizationOutcome

PersonName

RemoveEntriesResult

ScanFailure

ScanProgress

UnlinkedFolder

Type Aliases

AddFileResult

CleanFoldersResult

CleanupAnalysisResult

CleanupResult

ConvertCbrResult

ConvertCountResult

CreditRole

EmptyDeletedResult

OrganizeResult

OrphanFoldersCountResult

PickOrganizationFolderResult

RelinkFolderResult

RemoveEntryResult

ResyncResult

ScanResult

SetCoverResult

UnorganizedCountResult

Variables

CREDIT_ROLES

DELETED_BY_TANKOBON_FOLDER

MAX_COVER_BYTES

MAX_REPORTED_FAILURES

READ_TAG

metadata

Interfaces

MetadataCandidate

MetadataQuery

Type Aliases

MetadataApiSource

MetadataPageResult

MetadataSearchResult

MetadataSource

Variables

METADATA_API_SOURCES

METADATA_SOURCE_LABELS

Functions

isBedethequeAlbumUrl

isCoverUrl

pageSourceOf

reading-list

Interfaces

ReadingList

Type Aliases

ReadingListAddResult

ReadingListOrderResult

ReadingListResult

Variables

MAX_READING_LIST_SIZE

release-date

Functions

isValidReleaseDate

validReleaseDate

settings

Interfaces

AppSettings

HomeSectionSetting

ReaderBackgroundPreset

Type Aliases

ApiKeys

ApiKeySetting

BookRowView

HomeSection

HomeSectionLayout

LibraryLevel

LibraryOrganization

LibrarySort

LibraryView

PublicSettings

SettingValidators

ThemeSetting

Variables

API_KEY_SETTINGS

DEFAULT_SETTINGS

HOME_SECTION_DEFAULT_COUNT

HOME_SECTION_DEFAULT_LAYOUT

HOME_SECTION_HIDE_WHEN_EMPTY_DEFAULT

HOME_SECTION_LAYOUTS

HOME_SECTION_MAX_COUNT

HOME_SECTION_MIN_COUNT

HOME_SECTIONS

LIBRARY_LEVELS

LIBRARY_SORTS

MAIN_PROCESS_SETTINGS

MAX_BACKUP_INTERVAL_DAYS

MAX_BACKUP_KEEP

MAX_FILE_NAME_RULES

MAX_IGNORED_DUPLICATES

MAX_LIBRARY_LEVELS

MAX_PAGE_SPACING

MAX_SETTING_TEXT

MAX_TRASH_RETENTION_DAYS

READER_BACKGROUND_PRESETS

SETTING_VALIDATORS

SHARED_SETTINGS

THEME_SETTINGS

Functions

isApiKeySetting

isHomeSections

isLibraryStructure

isSettingKey

isSharedSetting

isValidSetting

pickApiKeys

toPublicSettings

stats

Interfaces

ReadingDay

ReadingHistoryEntry

ReadingStats

Variables

READING_HISTORY_LIMIT

title-parsing

Functions

formatPersonName

splitPersonName

splitSeriesTitle

users

Interfaces

UserProfile

UsersState

Type Aliases

AvatarType

PickAvatarResult

UserResult

Variables

AVATAR_SIZE

DEFAULT_USER_ID

MAX_AVATAR_BYTES

MAX_AVATAR_SOURCE_BYTES

MAX_NICKNAME_LENGTH

Functions

avatarType

normalizeNickname

On this page

Skeudenn / hooks/use-launch-file

hooks/use-launch-file

Opening the comic the operating system asked for.

Functions

useLaunchFile

Edit this page on GitHub

Pager

Previous pageuseImageUpscaler

Next pageuseLaunchFile