Class Group

constructor

• new Group(schem: ScanlationGroupSchema): Group

  Parameters

  • schem: ScanlationGroupSchema

  Returns Group

altNames

contactEmail

createdAt

description

discord

exLicensed

focusedLanguage

id

inactive

ircChannel

ircServer

leader

locked

mangaUpdates

members

name

official

publishDelay

twitter

updatedAt

verified

version

website

changeFollowship

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

  Makes the user follow or unfollow this group

  Parameters

  • follow: boolean = true

  Returns Promise<void>

delete

• delete(): Promise<void>

  Deletes this group

  Returns Promise<void>

getStatistics

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

  Gets the statistics about this group

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

update

• update(data: Omit<CreateScanlationGroupSchema, "version">): Promise<Group>

  Updates a group's information.

  Parameters

  • data: Omit<CreateScanlationGroupSchema, "version">

  Returns Promise<Group>

StaticchangeFollowship

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

  Makes the logged in user follow or unfollow a group

  Parameters

  • id: string
  • follow: boolean = true

  Returns Promise<void>

Staticcreate

• create(data: CreateScanlationGroupSchema): Promise<Group>

  Create a new group

  Parameters

  • data: CreateScanlationGroupSchema

  Returns Promise<Group>

Staticdelete

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

  Deletes a group by their id

  Parameters

  • id: string

  Returns Promise<void>

Staticget

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

  Retrieves a group by their id

  Parameters

  • id: string

  Returns Promise<Group>

StaticgetByQuery

• getByQuery(
      query?: Partial<Merge<GetSearchGroupParamsSchema, { ids: Group[] }>>,
  ): Promise<Group | null>

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

  Parameters

  • Optionalquery: Partial<Merge<GetSearchGroupParamsSchema, { ids: Group[] }>>

  Returns Promise<Group | null>

StaticgetFollowedGroups

• getFollowedGroups(query?: RequestQuery): Promise<Group[]>

  Gets an array of groups that the current user follows

  Parameters

  • query: RequestQuery = ...

  Returns Promise<Group[]>

StaticgetMultiple

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

  Retrieves an array of groups by an array of ids

  Parameters

  • ids: string[]

  Returns Promise<Group[]>

StaticgetStatistics

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

  Gets the statistics about a list of groups

  Parameters

  • ids: string[] | Group[]

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

Staticsearch

• search(
      query?: Partial<Merge<GetSearchGroupParamsSchema, { ids: Group[] }>>,
  ): Promise<Group[]>

  Retrieves a list of groups according to the specified search parameters

  Parameters

  • Optionalquery: Partial<Merge<GetSearchGroupParamsSchema, { ids: Group[] }>>

  Returns Promise<Group[]>