Class Cover

constructor

• new Cover(schem: CoverSchema): Cover

• Parameters

  • schem: CoverSchema

  Returns Cover

createdAt

description

fileName

id

locale

manga

updatedAt

uploader

url

version

volume

delete

• delete(): Promise<void>

• Deletes this cover

  Returns Promise<void>

update

• update(data: Omit<CoverEditSchema, "version">): Promise<Cover>

• Updates a cover's information.

  Parameters

  • data: Omit<CoverEditSchema, "version">

  Returns Promise<Cover>

Static create

• create(manga: string | Manga, data: CoverUploadBody): Promise<Cover>

• Uploads a new cover

  Parameters

  • manga: string | Manga

  • data: CoverUploadBody

  Returns Promise<Cover>

Static delete

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

• Deletes a cover by their id

  Parameters

  • id: string

  Returns Promise<void>

Static get

• get(id: string | Manga, expandedTypes?: ReferenceExpansionCoverArtSchema): Promise<Cover>

• Retrieves a cover by its id

  Parameters

  • id: string | Manga

  • Optional expandedTypes: ReferenceExpansionCoverArtSchema

  Returns Promise<Cover>

Static getByQuery

• getByQuery(query?: Partial<Merge<GetCoverParamsSchema, {
      ids: Cover[];
      manga: Manga[];
  }>>): Promise<null | Cover>

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

  Parameters

  • Optional query: Partial<Merge<GetCoverParamsSchema, {
        ids: Cover[];
        manga: Manga[];
    }>>

  Returns Promise<null | Cover>

Static getMangaCovers

• getMangaCovers(manga: string | string[] | Manga | Manga[], expandedTypes?: ReferenceExpansionCoverArtSchema): Promise<Cover[]>

• Returns an array of covers from an array of manga ids or a single manga

  Parameters

  • manga: string | string[] | Manga | Manga[]

  • Optional expandedTypes: ReferenceExpansionCoverArtSchema

  Returns Promise<Cover[]>

Static getMultiple

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

• Retrieves an array of covers by an array of ids

  Parameters

  • ids: string[]

  Returns Promise<Cover[]>

Static search

• search(query?: Partial<Merge<GetCoverParamsSchema, {
      ids: Cover[];
      manga: Manga[];
  }>>): Promise<Cover[]>

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

  Parameters

  • Optional query: Partial<Merge<GetCoverParamsSchema, {
        ids: Cover[];
        manga: Manga[];
    }>>

  Returns Promise<Cover[]>