Skeudenn / shared/library / CleanupAnalysisResult
Type Alias: CleanupAnalysisResult ​
CleanupAnalysisResult = {
message:string;status:"error"; } | {booksWithJunk:number;failed:number;groups:CleanupGroup[];scanned:number;skipped:number;status:"ok";token:string; }
Defined in: src/shared/library.ts:284
Outcome of library.analyzeCleanup(): what removing the non-image files from the archives would delete. Nothing is touched yet; token is what library.applyCleanup() takes to do it.
Union Members ​
Type Literal ​
{ message: string; status: "error"; }
Type Literal ​
{ booksWithJunk: number; failed: number; groups: CleanupGroup[]; scanned: number; skipped: number; status: "ok"; token: string; }
booksWithJunk ​
booksWithJunk:
number
Books holding at least one non-image file.
failed ​
failed:
number
Books that could not be read.
groups ​
groups:
CleanupGroup[]
The kinds of files found, biggest first (empty when the books are already clean).
scanned ​
scanned:
number
Books analyzed.
skipped ​
skipped:
number
Books left out: not a CBZ (RAR and PDF can't be rewritten) or a cloud placeholder not downloaded.
status ​
status:
"ok"
token ​
token:
string
Opaque handle of the analysis; works once, the latest ones only.