Class List

constructor

• new List(schem: CustomListSchema): List

• Parameters

  • schem: CustomListSchema

  Returns List

creator

id

manga

name

version

visibility

addManga

• addManga(manga: string | Manga): Promise<void>

• Add a manga to this list

  Parameters

  • manga: string | Manga

  Returns Promise<void>

changeVisibility

• changeVisibility(newVis: "private" | "public"): Promise<List>

• Changes the visibility of this custom list

  Parameters

  • newVis: "private" | "public"

  Returns Promise<List>

delete

• delete(): Promise<void>

• Deletes this list

  Returns Promise<void>

follow

• follow(): Promise<void>

• Make the currently authenticated user follow this list

  Returns Promise<void>

getFeed

• getFeed(query?: Partial<GetListIdFeedParamsSchema>): Promise<Chapter[]>

• Returns an array of chapters from the manga in this list

  Parameters

  • Optional query: Partial<GetListIdFeedParamsSchema>

  Returns Promise<Chapter[]>

removeManga

• removeManga(manga: string | Manga): Promise<void>

• Remove a manga from this list

  Parameters

  • manga: string | Manga

  Returns Promise<void>

rename

• rename(name: string): Promise<List>

• Renames this custom list

  Parameters

  • name: string

  Returns Promise<List>

unfollow

• unfollow(): Promise<void>

• Make the currently authenticated user unfollow this list

  Returns Promise<void>

update

• update(data: Partial<Omit<CustomListCreateSchema, "version">>): Promise<List>

• Updates a list's information.

  Parameters

  • data: Partial<Omit<CustomListCreateSchema, "version">>

  Returns Promise<List>

updateMangaList

• updateMangaList(newList: string[] | Manga[]): Promise<List>

• Parameters

  • newList: string[] | Manga[]

  Returns Promise<List>

Static addManga

• addManga(listId: string, manga: string | Manga): Promise<void>

• Add a manga to a list

  Parameters

  • listId: string

  • manga: string | Manga

  Returns Promise<void>

Static create

• create(data: CustomListCreateSchema): Promise<List>

• Create a new list

  Parameters

  • data: CustomListCreateSchema

  Returns Promise<List>

Static delete

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

• Deletes a list by its id

  Parameters

  • id: string

  Returns Promise<void>

Static follow

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

• Make the currently authenticated user follow a list

  Parameters

  • id: string

  Returns Promise<void>

Static get

• get(id: string): Promise<List>

• Retrieves a list by its id

  Parameters

  • id: string

  Returns Promise<List>

Static getFeed

• getFeed(listId: string, query?: Partial<GetListIdFeedParamsSchema>): Promise<Chapter[]>

• Returns an array of chapters from the manga in a list

  Parameters

  • listId: string

  • Optional query: Partial<GetListIdFeedParamsSchema>

  Returns Promise<Chapter[]>

Static getFollowedLists

• getFollowedLists(limit?: number, offset?: number): Promise<List[]>

• Returns all lists followed by the currently authenticated user

  Parameters

  • limit: number = Infinity

  • offset: number = 0

  Returns Promise<List[]>

Static getLoggedInUserLists

• getLoggedInUserLists(limit?: number, offset?: number): Promise<List[]>

• Returns all of the currently authenticated user's custom manga lists

  Parameters

  • limit: number = Infinity

  • offset: number = 0

  Returns Promise<List[]>

Static getUserLists

• getUserLists(user: string | User, limit?: number, offset?: number): Promise<List[]>

• Returns all of a user's custom manga lists

  Parameters

  • user: string | User

  • limit: number = Infinity

  • offset: number = 0

  Returns Promise<List[]>

Static removeManga

• removeManga(listId: string, manga: string | Manga): Promise<void>

• Remove a manga from a list

  Parameters

  • listId: string

  • manga: string | Manga

  Returns Promise<void>

Static unfollow

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

• Make the currently authenticated user unfollow a list

  Parameters

  • id: string

  Returns Promise<void>