Class GuildBanManager

guild

bulkCreate

• bulkCreate(
      users:
          | readonly UserResolvable[]
          | ReadonlyCollection<string, UserResolvable>,
      options?: BulkBanOptions,
  ): Promise<BulkBanResult>

  Parameters

  • users: readonly UserResolvable[] | ReadonlyCollection<string, UserResolvable>
  • Optionaloptions: BulkBanOptions

  Returns Promise<BulkBanResult>

create

• create(
      user: UserResolvable,
      options?: BanOptions,
  ): Promise<string | User | GuildMember>

  Parameters

  • user: UserResolvable
  • Optionaloptions: BanOptions

  Returns Promise<string | User | GuildMember>

fetch

• fetch(options: UserResolvable | FetchBanOptions): Promise<GuildBan>

  Parameters

  • options: UserResolvable | FetchBanOptions

  Returns Promise<GuildBan>

• fetch(options?: FetchBansOptions): Promise<Collection<string, GuildBan>>

  Parameters

  • Optionaloptions: FetchBansOptions

  Returns Promise<Collection<string, GuildBan>>

remove

• remove(user: UserResolvable, reason?: string): Promise<null | User>

  Parameters

  • user: UserResolvable
  • Optionalreason: string

  Returns Promise<null | User>