glax/Tranga
2
0
Fork 0
Code

Types documentation add quotation marks

Browse Source
This commit is contained in:
Glax 2024-10-20 18:32:49 +02:00
parent 240af81fa9
commit f9a30f2587
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/Types.md
View File

@ -36,12 +36,12 @@
## Chapter ## Chapter
``` ```
{ {
parentManga: IManga, "parentManga": IManga,
name: string | undefined, "name": string | undefined,
volumeNumber: string, "volumeNumber": string,
chapterNumber: string, "chapterNumber": string,
url: string, "url": string,
fileName: string "fileName": string
} }
``` ```
@ -59,18 +59,18 @@
## Job ## Job
``` ```
{ {
progressToken: IProgressToken, "progressToken": IProgressToken,
recurring: boolean, "recurring": boolean,
recurrenceTime: string, "recurrenceTime": string,
lastExecution: Date, "lastExecution": Date,
nextExecution: Date, "nextExecution": Date,
id: string, "id": string,
jobType: number, //see JobType "jobType": number, //see JobType
parentJobId: string | null, "parentJobId": string | null,
mangaConnector: IMangaConnector, "mangaConnector": IMangaConnector,
mangaInternalId: string | undefined, //only on DownloadNewChapters "mangaInternalId": string | undefined, //only on DownloadNewChapters
translatedLanguage: string | undefined, //only on DownloadNewChapters "translatedLanguage": string | undefined, //only on DownloadNewChapters
chapter: IChapter | undefined, //only on DownloadChapter "chapter": IChapter | undefined, //only on DownloadChapter
} }
``` ```
@ -87,14 +87,14 @@
## ProgressToken ## ProgressToken
``` ```
{ {
cancellationRequested: boolean, "cancellationRequested": boolean,
increments: number, "increments": number,
incrementsCompleted: number, "incrementsCompleted": number,
progress: number, "progress": number,
lastUpdate: Date, "lastUpdate": Date,
executionStarted: Date, "executionStarted": Date,
timeRemaining: Date, "timeRemaining": Date,
state: number "state": number
} }
``` ```