Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BanStore

The store for bans.

since

0.0.1

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private #limit

#limit: number

The cache limit of this DataStore

Protected Readonly Holds

Holds: Constructor<Ban>

Readonly client

client: Client

Readonly guild

guild: Guild

The guild this store belongs to.

since

0.0.1

Readonly size

size: number

Accessors

first

  • get first(): [string, Ban] | null

  • The first item in this Cache

    Returns [string, Ban] | null

firstKey

  • get firstKey(): string | null

  • The first key of this cache

    Returns string | null

firstValue

  • get firstValue(): Ban | null

  • The first value of this cache

    Returns Ban | null

last

  • get last(): [string, Ban] | null

  • The last item in this cache

    Returns [string, Ban] | null

lastKey

  • get lastKey(): string | null

  • The last key of this cache

    Returns string | null

lastValue

  • get lastValue(): Ban | null

  • The last value of this cache

    Returns Ban | null

Static [Symbol.species]

  • get [Symbol.species](): typeof Cache

Methods

Protected _add

  • _add(data: GuildBanAddDispatch["d"]): Ban

add

clear

  • clear(): void

  • Returns void

clone

  • clone(): Cache<string, Ban>

  • Returns a shallow clone of this Cache

    Returns Cache<string, Ban>

concat

  • concat(...caches: Cache<string, Ban>[]): Cache<string, Ban>

  • Returns a new Cache with this and other caches together

    Parameters

    • Rest ...caches: Cache<string, Ban>[]

      Other caches to include in the new cache

    Returns Cache<string, Ban>

delete

  • delete(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

equals

  • equals(cache: Cache<string, Ban>): boolean

  • Naive equality compare function

    Parameters

    • cache: Cache<string, Ban>

      The cache to compare this against

    Returns boolean

every

  • every(fn: (value: Ban, key: string, map: this) => boolean, thisArg?: any): boolean

  • Tests if every entry in this cache meets a condition

    Parameters

    • fn: (value: Ban, key: string, map: this) => boolean

      The function to test the condition

        • (value: Ban, key: string, map: this): boolean

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns boolean

fetch

  • fetch(options: { cache?: undefined | false | true; id: string }): Promise<Ban>
  • fetch(options: { cache: false }): Promise<Cache<string, Ban>>
  • fetch(options?: undefined | { cache?: undefined | true }): Promise<this>

  • Retrieves an individual Ban from the API.

    since

    0.0.1

    example

    const ban = await message.guild.bans.fetch({ id: '339944237305036812' }); console.log(The user ${ban.id} was banned for the reason: ${ban.reason}.);

    Parameters

    • options: { cache?: undefined | false | true; id: string }

      The options containing the User's ID

      • Optional cache?: undefined | false | true
      • id: string

    Returns Promise<Ban>

  • Retrieves all bans for this guild from the API, returning all values as a {@link Cache} without populating the store.

    since

    0.0.1

    example

    const bans = await message.guild.bans.fetch({ cache: false }); console.log(${bans.size} users are banned.);

    Parameters

    • options: { cache: false }

      The options without an User's ID.

      • cache: false

    Returns Promise<Cache<string, Ban>>

  • Retrieves all bans for this guild from the API, populating the store and returning itself.

    since

    0.0.1

    example

    const bans = await message.guild.bans.fetch(); console.log(${bans.size} users are banned.);

    example

    const bans = await message.guild.bans.fetch({ cache: true }); console.log(${bans.size} users are banned.);

    Parameters

    • Optional options: undefined | { cache?: undefined | true }

      The options without an User's ID.

    Returns Promise<this>

filter

  • filter(fn: (value: Ban, key: string, map: this) => boolean, thisArg?: any): Cache<string, Ban>

  • Returns a new filtered Cache based on the filter function

    Parameters

    • fn: (value: Ban, key: string, map: this) => boolean

      Function used to determine what entries are in the new Cache

        • (value: Ban, key: string, map: this): boolean

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns Cache<string, Ban>

find

  • find(fn: (value: Ban, key: string, map: this) => boolean, thisArg?: any): [string, Ban] | undefined

  • Finds an entry from this Cache

    Parameters

    • fn: (value: Ban, key: string, map: this) => boolean

      Function used to find what you are looking for

        • (value: Ban, key: string, map: this): boolean

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns [string, Ban] | undefined

findKey

  • findKey(fn: (value: Ban, key: string, map: this) => boolean, thisArg?: any): string | undefined

  • Finds a key from this Cache

    Parameters

    • fn: (value: Ban, key: string, map: this) => boolean

      Function used to find what you are looking for

        • (value: Ban, key: string, map: this): boolean

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns string | undefined

findValue

  • findValue(fn: (value: Ban, key: string, map: this) => boolean, thisArg?: any): Ban | undefined

  • Finds a value from this Cache

    Parameters

    • fn: (value: Ban, key: string, map: this) => boolean

      Function used to find what you are looking for

        • (value: Ban, key: string, map: this): boolean

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns Ban | undefined

forEach

  • forEach(callbackfn: (value: Ban, key: string, map: Map<string, Ban>) => void, thisArg?: any): void

  • Parameters

    • callbackfn: (value: Ban, key: string, map: Map<string, Ban>) => void
        • (value: Ban, key: string, map: Map<string, Ban>): void

        • Parameters

          • value: Ban
          • key: string
          • map: Map<string, Ban>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: string): Ban | undefined

  • Parameters

    • key: string

    Returns Ban | undefined

has

  • has(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

map

  • map<T>(fn: (value: Ban, key: string, map: this) => T, thisArg?: any): T[]

  • Maps this Cache to an array (like Array#map())

    Type parameters

    • T

    Parameters

    • fn: (value: Ban, key: string, map: this) => T

      Function to determine what is mapped to the new Array

        • (value: Ban, key: string, map: this): T

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns T

    • Optional thisArg: any

      Optional binding for the fn param

    Returns T[]

reduce

  • reduce<I>(fn: (accumulator: I, value: Ban, key: string, map: this) => I, initialValue: I, thisArg?: any): I

  • Reduces this cache into a singularity

    Type parameters

    • I

    Parameters

    • fn: (accumulator: I, value: Ban, key: string, map: this) => I

      The function to determine how this Cache is reduced

        • (accumulator: I, value: Ban, key: string, map: this): I

        • Parameters

          • accumulator: I
          • value: Ban
          • key: string
          • map: this

          Returns I

    • initialValue: I

      The initial value

    • Optional thisArg: any

      Optional binding for the fn param

    Returns I

remove

  • remove(userID: string, requestOptions?: RequestOptions): Promise<this>

resolve

  • resolve(data: unknown): Ban | null

resolveID

  • resolveID(data: unknown): string | null

set

  • set(key: string, value: Ban): this

some

  • some(fn: (value: Ban, key: string, map: this) => boolean, thisArg?: any): boolean

  • Tests if some entries in this cache meets a condition

    Parameters

    • fn: (value: Ban, key: string, map: this) => boolean

      The function to test the condition

        • (value: Ban, key: string, map: this): boolean

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns boolean

sort

  • sort(compareFunction?: undefined | ((v0: Ban, v1: Ban, k0?: K, k1?: K) => number)): this

  • Sorts entries in-place in this Cache

    Parameters

    • Optional compareFunction: undefined | ((v0: Ban, v1: Ban, k0?: K, k1?: K) => number)

      Function to determine how this Cache should be sorted

    Returns this

sorted

  • sorted(compareFunction?: undefined | ((v0: Ban, v1: Ban, k0?: K, k1?: K) => number)): Cache<string, Ban>

  • Sorts entries in a new Cache

    Parameters

    • Optional compareFunction: undefined | ((v0: Ban, v1: Ban, k0?: K, k1?: K) => number)

      Function to determine how the resulting Cache should be sorted

    Returns Cache<string, Ban>

sweep

  • sweep(fn: (value: Ban, key: string, map: this) => boolean, thisArg?: any): number

  • Sweeps entries from this Cache

    Parameters

    • fn: (value: Ban, key: string, map: this) => boolean

      Function used to determine what entries are swept

        • (value: Ban, key: string, map: this): boolean

        • Parameters

          • value: Ban
          • key: string
          • map: this

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns number

toJSON

  • toJSON(): string[]

Generated using TypeDoc