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>

Staticcreate

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

  Uploads a new cover

  Parameters

  • manga: string | Manga
  • data: CoverUploadBody

  Returns Promise<Cover>

Staticdelete

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

  Deletes a cover by their id

  Parameters

  • id: string

  Returns Promise<void>

Staticget

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

  Retrieves a cover by its id

  Parameters

  • id: string | Manga
  • OptionalexpandedTypes: ReferenceExpansionCoverArtSchema

  Returns Promise<Cover>

StaticgetByQuery

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

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

  Parameters

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

  Returns Promise<Cover | null>

StaticgetMangaCovers

• 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[]
  • OptionalexpandedTypes: ReferenceExpansionCoverArtSchema

  Returns Promise<Cover[]>

StaticgetMultiple

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

  Retrieves an array of covers by an array of ids

  Parameters

  • ids: string[]

  Returns Promise<Cover[]>

Staticsearch

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

  Retrieves a list of covers according to the specified search parameters

  Parameters

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

  Returns Promise<Cover[]>