Class ChapterInternal

constructor

• new Chapter(schem: ChapterSchema): Chapter

  Parameters

  • schem: ChapterSchema

  Returns Chapter

chapter

createdAt

externalUrl

groups

id

isExternal

isUnavailable

manga

pages

publishAt

readableAt

title

translatedLanguage

updatedAt

uploader

version

volume

delete

• delete(): Promise<void>

  Delete a chapter by its UUID

  Returns Promise<void>

getReadablePages

• getReadablePages(saver?: boolean, forcePort?: boolean): Promise<string[]>

  Returns an array of image URLs for this chapter's pages. Once an image is requested, if the host is from MangaDex(at)Home, please report if it succeeds or fails by using reportPageURL.

  Parameters

  • saver: boolean = false

    If true, the URLs will be for the compressed data-saver images (if available).

  • forcePort: boolean = false

    If true, the URLs will be forced to be on port 443.

  Returns Promise<string[]>

getStatistics

• getStatistics(): Promise<
      Required<{ comments: StatisticsDetailsCommentsSchema }>,
  >

  Gets the statistics about this chapter

  Returns Promise<Required<{ comments: StatisticsDetailsCommentsSchema }>>

update

• update(data: Omit<ChapterEditSchema, "version">): Promise<Chapter>

  Update this chapter's information

  Parameters

  • data: Omit<ChapterEditSchema, "version">

  Returns Promise<Chapter>

Staticdelete

• delete(id: string): Promise<void>

  Delete this chapter

  Parameters

  • id: string

  Returns Promise<void>

Staticget

• get(
      id: string,
      expandedTypes?: ("user" | "scanlation_group" | "manga")[],
  ): Promise<Chapter>

  Retrieves a chapter object by its UUID

  Parameters

  • id: string
  • OptionalexpandedTypes: ("user" | "scanlation_group" | "manga")[]

  Returns Promise<Chapter>

StaticgetByQuery

• getByQuery(
      query?: Partial<
          Merge<
              GetChapterParamsSchema,
              { groups: Group[]; ids: Chapter[]; uploader: User
              | User[] },
          >,
      >,
  ): Promise<Chapter | null>

  Performs a search for a chapter and returns the first one found. If no results are found, null is returned

  Parameters

  • Optionalquery: Partial<
        Merge<
            GetChapterParamsSchema,
            { groups: Group[]; ids: Chapter[]; uploader: User
            | User[] },
        >,
    >

  Returns Promise<Chapter | null>

StaticgetMultiple

• getMultiple(ids: string[]): Promise<Chapter[]>

  Retrieves an array of chapters by an array of their ids

  Parameters

  • ids: string[]

  Returns Promise<Chapter[]>

StaticgetStatistics

• getStatistics(
      ids: string[] | Chapter[],
  ): Promise<
      Record<string, Required<{ comments: StatisticsDetailsCommentsSchema }>>,
  >

  Gets the statistics about a list of chapters

  Parameters

  • ids: string[] | Chapter[]

  Returns Promise<Record<string, Required<{ comments: StatisticsDetailsCommentsSchema }>>>

StaticreportPageURL

• reportPageURL(
      report: {
          bytes: number;
          cached: boolean;
          duration: number;
          success: boolean;
          url: string;
      },
  ): Promise<void>

  Sends a report to MangaDex about the success/failure of a MangaDex(at)Home server. Read more information: https://api.mangadex.org/docs/04-chapter/retrieving-chapter/#mangadexhome-load-successes-failures-and-retries

  Parameters

  • report: {
        bytes: number;
        cached: boolean;
        duration: number;
        success: boolean;
        url: string;
    }

  Returns Promise<void>

Staticsearch

• search(
      query?: Partial<
          Merge<
              GetChapterParamsSchema,
              { groups: Group[]; ids: Chapter[]; uploader: User
              | User[] },
          >,
      >,
  ): Promise<Chapter[]>

  Retrieves a list of chapters according to the specified search parameters

  Parameters

  • Optionalquery: Partial<
        Merge<
            GetChapterParamsSchema,
            { groups: Group[]; ids: Chapter[]; uploader: User
            | User[] },
        >,
    >

  Returns Promise<Chapter[]>