Class Manga

constructor

• new Manga(schem: MangaSchema): Manga

• Parameters

  • schem: MangaSchema

  Returns Manga

altTitles

artists

authors

availableTranslatedLanguages

chapterNumbersResetOnNewVolume

contentRating

createdAt

description

id

isLocked

lastChapter

lastVolume

latestUploadedChapter

links

mainCover

originalLanguage

publicationDemographic

relatedManga

state

status

tags

title

updatedAt

version

year

localAltTitles

• get localAltTitles(): string[]

• List of alternate titles for manga according to the global locale.

  Returns string[]

  See

  localString

localDescription

• get localDescription(): string

• The description of this manga according to the global locale.

  Returns string

  See

  localString

localTitle

• get localTitle(): string

• The title of this manga according to the global locale.

  Returns string

  See

  localString

addRelation

• addRelation(targetId: string, relationType: "monochrome" | "main_story" | "adapted_from" | "based_on" | "prequel" | "side_story" | "doujinshi" | "same_franchise" | "shared_universe" | "sequel" | "spin_off" | "alternate_story" | "alternate_version" | "preserialization" | "colored" | "serialization"): Promise<void>

• Creates a relation (eg sequel/prequel, monochrome/colored, spin-off, etc) between this manga and another

  Parameters

  • targetId: string

    The target manga for the relation (eg the sequel, spin-off, etc)

  • relationType: "monochrome" | "main_story" | "adapted_from" | "based_on" | "prequel" | "side_story" | "doujinshi" | "same_franchise" | "shared_universe" | "sequel" | "spin_off" | "alternate_story" | "alternate_version" | "preserialization" | "colored" | "serialization"

  Returns Promise<void>

changeFollowship

• changeFollowship(follow?: boolean): Promise<void>

• Makes the user follow or unfollow this manga

  Parameters

  • follow: boolean = true

  Returns Promise<void>

delete

• delete(): Promise<void>

• Deletes this manga

  Returns Promise<void>

getAggregate

• getAggregate(groups?: string[] | Group[], languages?: string[]): Promise<Required<{}>>

• Returns an abridged list of chapter ids for this manga separated by their volumes

  Parameters

  • Optional groups: string[] | Group[]

  • Optional languages: string[]

  Returns Promise<Required<{}>>

getCovers

• getCovers(): Promise<Cover[]>

• Gets all covers for this manga

  Returns Promise<Cover[]>

getFeed

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

• Returns an array of this manga's chapters

  Parameters

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

  Returns Promise<Chapter[]>

getReadChapters

• getReadChapters(): Promise<Chapter[]>

• Returns an array of read chapters for this manga

  Returns Promise<Chapter[]>

getReadingStatus

• getReadingStatus(): Promise<"completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading">

• Gets the reading status (eg completed, reading, dropped, etc) for this manga for the currently authenticated user

  Returns Promise<"completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading">

getRelations

• getRelations(expandTypes?: boolean): Promise<RelatedManga>

• Gets all of this manga's relations to other manga.

  Parameters

  • expandTypes: boolean = false

  Returns Promise<RelatedManga>

getStatistics

• getStatistics(): Promise<Required<{
      comments: StatisticsDetailsCommentsSchema;
      follows: number;
      rating: Required<({ average: number | null; bayesian: number; })>;
  }>>

• Gets the statistics about this manga including its rating distribution, comment count, and follow count

  Returns Promise<Required<{
      comments: StatisticsDetailsCommentsSchema;
      follows: number;
      rating: Required<({ average: number | null; bayesian: number; })>;
  }>>

getUserRating

• getUserRating(): Promise<null | number>

• Returns the rating that the currently authenticated user gave to this manga on a scale of 1-10, or returns null if there is no rating.

  Returns Promise<null | number>

giveRating

• giveRating(rating: number): Promise<void>

• Makes the currently authenticated user give this manga a rating between 1-10 (inclusive).

  Parameters

  • rating: number

  Returns Promise<void>

removeRating

• removeRating(): Promise<void>

• Removes the currently authenticated user's rating for this manga

  Returns Promise<void>

removeRelation

• removeRelation(relationId: string): Promise<void>

• Removes a relation from this manga by the relation's id

  Parameters

  • relationId: string

  Returns Promise<void>

setReadingStatus

• setReadingStatus(status: null | "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading"): Promise<void>

• Sets this manga's reading status (eg completed, reading, dropped, etc) for the currently authenticated user. If the status is null, the current reading status will be removed.

  Parameters

  • status: null | "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading"

  Returns Promise<void>

update

• update(data: Omit<MangaRequestSchema, "version">): Promise<Manga>

• Updates this manga's information.

  Parameters

  • data: Omit<MangaRequestSchema, "version">

  Returns Promise<Manga>

updateReadChapters

• updateReadChapters(chapters: {
      read?: (string | Chapter)[];
      unread?: (string | Chapter)[];
  }, updateHistory?: boolean): Promise<undefined | never[]>

• Marks lists of chapters read or unread for this manga

  Parameters

  • chapters: {
        read?: (string | Chapter)[];
        unread?: (string | Chapter)[];
    }

    • Optional read?: (string | Chapter)[]

    • Optional unread?: (string | Chapter)[]

  • updateHistory: boolean = false

  Returns Promise<undefined | never[]>

Static addRelation

• addRelation(id: string, targetId: string, relationType: "monochrome" | "main_story" | "adapted_from" | "based_on" | "prequel" | "side_story" | "doujinshi" | "same_franchise" | "shared_universe" | "sequel" | "spin_off" | "alternate_story" | "alternate_version" | "preserialization" | "colored" | "serialization"): Promise<void>

• Creates a relation between two manga (eg sequel/prequel, monochrome/colored, spin-off, etc)

  Parameters

  • id: string

    The origin manga

  • targetId: string

    The target manga for the relation (eg the sequel, spin-off, etc)

  • relationType: "monochrome" | "main_story" | "adapted_from" | "based_on" | "prequel" | "side_story" | "doujinshi" | "same_franchise" | "shared_universe" | "sequel" | "spin_off" | "alternate_story" | "alternate_version" | "preserialization" | "colored" | "serialization"

  Returns Promise<void>

Static changeFollowship

• changeFollowship(id: string, follow?: boolean): Promise<void>

• Makes the logged in user follow or unfollow a manga

  Parameters

  • id: string

  • follow: boolean = true

  Returns Promise<void>

Static commitDraft

• commitDraft(draftId: string, manga: Partial<MangaAttributesSchema>): Promise<Manga>

• Commits a manga object as a draft. A Manga draft that is to be submitted must have at least one cover in the original language, must be in the "draft" state, and must be passed the correct version in the request body.

  Parameters

  • draftId: string

  • manga: Partial<MangaAttributesSchema>

  Returns Promise<Manga>

Static convertLegacyId

• convertLegacyId(type: "group" | "chapter" | "manga" | "tag", ids: number[]): Promise<Record<number, string>>

• Converts legacy pre-V5 MangaDex ids to modern UUIDs. Returns a record with legacy ids as the keys and new ids as the values.

  Parameters

  • type: "group" | "chapter" | "manga" | "tag"

  • ids: number[]

  Returns Promise<Record<number, string>>

Static create

• create(data: MangaRequestSchema): Promise<Manga>

• Create a new manga. MangaDex only allows admins to use this endpoint. Use the a manga draft instead

  Parameters

  • data: MangaRequestSchema

  Returns Promise<Manga>

Static delete

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

• Deletes a manga by its id

  Parameters

  • id: string

  Returns Promise<void>

Static get

• get(id: string, expandedTypes?: ReferenceExpansionMangaSchema): Promise<Manga>

• Retrieves a manga object by its UUID

  Parameters

  • id: string

  • Optional expandedTypes: ReferenceExpansionMangaSchema

  Returns Promise<Manga>

Static getAggregate

• getAggregate(id: string, groups?: string[] | Group[], languages?: string[]): Promise<Required<{}>>

• Returns an abridged list of chapter ids for a manga separated by their volumes

  Parameters

  • id: string

  • Optional groups: string[] | Group[]

  • Optional languages: string[]

  Returns Promise<Required<{}>>

Static getAllReadingStatus

• getAllReadingStatus(filter?: "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading"): Promise<Record<string, "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading">>

• Get every reading status (eg completed, reading, dropped, etc) for every manga marked by the currently authenticated user.

  Parameters

  • Optional filter: "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading"

    If specified, only manga with this status will be returned

  Returns Promise<Record<string, "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading">>

Static getByQuery

• getByQuery(query?: Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>): Promise<null | Manga>

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

  Parameters

  • Optional query: Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>

  Returns Promise<null | Manga>

Static getDraft

• getDraft(id: string, expandedTypes?: ReferenceExpansionMangaSchema): Promise<Manga>

• Retrieves a manga draft by its UUID

  Parameters

  • id: string

  • Optional expandedTypes: ReferenceExpansionMangaSchema

  Returns Promise<Manga>

Static getFeed

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

• Returns an array of a manga's chapters

  Parameters

  • id: string

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

  Returns Promise<Chapter[]>

Static getFollowedFeed

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

• Gets the combined feed of every manga followed by the logged in user

  Parameters

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

  Returns Promise<Chapter[]>

Static getFollowedManga

• getFollowedManga(query?: RequestQuery): Promise<Manga[]>

• Returns all manga followed by the currently authenticated user

  Parameters

  • query: RequestQuery = ...

  Returns Promise<Manga[]>

Static getMultiple

• getMultiple(ids: string[], extraParams?: Omit<Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>, "ids">): Promise<Manga[]>

• Retrieves an array of manga by an array of their ids

  Parameters

  • ids: string[]

  • Optional extraParams: Omit<Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>, "ids">

  Returns Promise<Manga[]>

Static getRandom

• getRandom(query?: Pick<Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>, keyof GetMangaRandomParamsSchema>): Promise<Manga>

• Retrieves a random manga

  Parameters

  • Optional query: Pick<Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>, keyof GetMangaRandomParamsSchema>

  Returns Promise<Manga>

Static getReadChapters

• getReadChapters(ids: string[] | Manga[]): Promise<Record<string, Chapter[]>>

• Returns an array of read chapters for a list of manga. The response is a record with the manga ids as the keys and chapter arrays as the values.

  Parameters

  • ids: string[] | Manga[]

  Returns Promise<Record<string, Chapter[]>>

Static getReadingStatus

• getReadingStatus(id: string): Promise<"completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading">

• Gets the reading status (eg completed, reading, dropped, etc) for a manga for the currently authenticated user

  Parameters

  • id: string

  Returns Promise<"completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading">

Static getRelations

• getRelations(id: string, expandTypes?: boolean): Promise<RelatedManga>

• Gets all of a manga's relations to other manga.

  Parameters

  • id: string

  • expandTypes: boolean = false

  Returns Promise<RelatedManga>

Static getStatistics

• getStatistics(ids: string[] | Manga[]): Promise<Record<string, Required<{
      comments: StatisticsDetailsCommentsSchema;
      follows: number;
      rating: Required<({ average: number | null; bayesian: number; })>;
  }>>>

• Gets the statistics about manga including their rating distribution, comment count, and follow count

  Parameters

  • ids: string[] | Manga[]

  Returns Promise<Record<string, Required<{
      comments: StatisticsDetailsCommentsSchema;
      follows: number;
      rating: Required<({ average: number | null; bayesian: number; })>;
  }>>>

Static getTotalSearchResults

• getTotalSearchResults(query?: Omit<Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>, "offset" | "limit">): Promise<number>

• Returns how many manga there are total for a search query

  Parameters

  • Optional query: Omit<Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>, "offset" | "limit">

  Returns Promise<number>

Static getUserRatings

• getUserRatings(ids: string[] | Manga[]): Promise<Record<string, null | {
      createdAt: Date;
      rating: number;
  }>>

• Returns a record of all ratings given by the currently authenticated user. The object is indexed by the manga ids and each value contains the numerical rating and when that rating was given. If a manga has no rating, 'null' is used as the value.

  Parameters

  • ids: string[] | Manga[]

  Returns Promise<Record<string, null | {
      createdAt: Date;
      rating: number;
  }>>

Static giveRating

• giveRating(mangaId: string, rating: number): Promise<void>

• Makes the currently authenticated user give a manga a rating between 1-10 (inclusive).

  Parameters

  • mangaId: string

  • rating: number

  Returns Promise<void>

Static removeRating

• removeRating(mangaId: string): Promise<void>

• Removes the currently authenticated user's rating for a manga

  Parameters

  • mangaId: string

  Returns Promise<void>

Static removeRelation

• removeRelation(mangaId: string, relationId: string): Promise<void>

• Removes a relation from a manga by the relation's id

  Parameters

  • mangaId: string

  • relationId: string

  Returns Promise<void>

Static search

• search(query?: Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>): Promise<Manga[]>

• Retrieves a list of manga according to the specified search parameters

  Parameters

  • Optional query: Partial<Merge<GetSearchMangaParamsSchema, MangaSearchHelpers>>

  Returns Promise<Manga[]>

  See

  cached for information on how to automatically resolve Relationships

Static searchDrafts

• searchDrafts(query?: Partial<GetMangaDraftsParamsSchema>): Promise<Manga[]>

• Retrieves a list of manga drafts according to the specified search parameters

  Parameters

  • Optional query: Partial<GetMangaDraftsParamsSchema>

  Returns Promise<Manga[]>

  See

  cached for information on how to automatically resolve Relationships

Static setReadingStatus

• setReadingStatus(id: string, status: null | "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading"): Promise<void>

• Sets a manga's reading status (eg completed, reading, dropped, etc) for the currently authenticated user. If the status is null, the current reading status will be removed.

  Parameters

  • id: string

  • status: null | "completed" | "reading" | "on_hold" | "plan_to_read" | "dropped" | "re_reading"

  Returns Promise<void>

Static updateReadChapters

• updateReadChapters(manga: string, chapters: {
      read?: (string | Chapter)[];
      unread?: (string | Chapter)[];
  }, updateHistory?: boolean): Promise<undefined | never[]>

• Marks lists of chapters read or unread for a single manga

  Parameters

  • manga: string

  • chapters: {
        read?: (string | Chapter)[];
        unread?: (string | Chapter)[];
    }

    • Optional read?: (string | Chapter)[]

    • Optional unread?: (string | Chapter)[]

  • updateHistory: boolean = false

  Returns Promise<undefined | never[]>