2
0
Tranga/docs/Types.md

117 lines
1.9 KiB
Markdown
Raw Normal View History

## Connector
```
{
"name": string,
"SupportedLanguages": string[],
2024-10-18 00:48:58 +02:00
"BaseUris": string[]
}
```
## Manga
```
2024-04-19 21:23:15 +02:00
{
2024-10-18 00:29:29 +02:00
"sortName": string,
"authors": string[],
"altTitles": string[][],
"description": string,
"tags": string[],
"coverUrl": string,
"coverFileNameInCache": string,
"links": string[][],
"year": int,
"originalLanguage": string,
"releaseStatus": ReleaseStatus, see ReleaseStatus
2024-10-18 00:29:29 +02:00
"folderName": string,
"publicationId": string,
"internalId": string,
"ignoreChaptersBelow": number,
"latestChapterDownloaded": number,
"latestChapterAvailable": number,
2024-10-18 00:29:29 +02:00
"websiteUrl": string,
"mangaConnector": Connector
2024-04-19 21:23:15 +02:00
}
```
## Chapter
```
2024-04-19 21:23:15 +02:00
{
2024-10-20 02:16:22 +02:00
parentManga: IManga,
name: string | undefined,
volumeNumber: string,
chapterNumber: string,
url: string,
fileName: string
2024-04-19 21:23:15 +02:00
}
```
2024-10-18 19:31:09 +02:00
## ReleaseStatus
```
{
Continuing = 0,
Completed = 1,
OnHiatus = 2,
Cancelled = 3,
Unreleased = 4
}
```
2024-04-19 21:23:15 +02:00
## Job
```
2024-04-19 21:23:15 +02:00
{
2024-10-20 02:16:22 +02:00
progressToken: IProgressToken,
recurring: boolean,
recurrenceTime: string,
lastExecution: Date,
nextExecution: Date,
id: string,
2024-10-20 02:16:22 +02:00
jobType: number, //see JobType
parentJobId: string | null,
2024-10-20 02:16:22 +02:00
mangaConnector: IMangaConnector,
mangaInternalId: string | undefined, //only on DownloadNewChapters
translatedLanguage: string | undefined, //only on DownloadNewChapters
chapter: IChapter | undefined, //only on DownloadChapter
2024-04-19 21:23:15 +02:00
}
```
## JobType
```
{
DownloadChapterJob = 0,
DownloadNewChaptersJob = 1,
UpdateMetaDataJob = 2,
MonitorManga = 3
}
```
2024-04-19 21:23:15 +02:00
## ProgressToken
```
2024-04-19 21:23:15 +02:00
{
cancellationRequested: boolean,
increments: number,
incrementsCompleted: number,
progress: number,
lastUpdate: Date,
executionStarted: Date,
timeRemaining: Date,
state: number
2024-04-19 21:23:15 +02:00
}
```
## Settings
```
2024-04-19 21:23:15 +02:00
{
}
```
## LibraryConnector
```
2024-04-19 21:23:15 +02:00
{
}
```
## NotificationConnector
```
2024-04-19 21:23:15 +02:00
{
}
```