Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GuildMemberStore

The store for guild members.

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<GuildMember>

Readonly client

client: Client

Readonly guild

guild: Guild

The guild this store belongs to.

since

0.0.1

Readonly size

size: number

Accessors

first

  • The first item in this Cache

    Returns [string, GuildMember] | null

firstKey

  • get firstKey(): string | null

  • The first key of this cache

    Returns string | null

firstValue

  • The first value of this cache

    Returns GuildMember | null

last

  • The last item in this cache

    Returns [string, GuildMember] | null

lastKey

  • get lastKey(): string | null

  • The last key of this cache

    Returns string | null

lastValue

  • The last value of this cache

    Returns GuildMember | null

Static [Symbol.species]

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

Methods

Protected _add

add

  • Adds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope.

    since

    0.0.1

    Parameters

    • userID: string

      The user ID to add.

    • data: GuildMemberStoreAddData

      The data to send for this request.

    • Default value requestOptions: RequestOptions = {}

      The additional request options.

    Returns Promise<GuildMember | null>

    A GuildMember instance if the user joined the server, null if it was already joined.

clear

  • clear(): void

  • Returns void

clone

  • Returns a shallow clone of this Cache

    Returns Cache<string, GuildMember>

concat

  • Returns a new Cache with this and other caches together

    Parameters

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

      Other caches to include in the new cache

    Returns Cache<string, GuildMember>

delete

  • delete(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

equals

  • Naive equality compare function

    Parameters

    • cache: Cache<string, GuildMember>

      The cache to compare this against

    Returns boolean

every

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

  • Tests if every entry in this cache meets a condition

    Parameters

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

      The function to test the condition

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

        • Parameters

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns boolean

fetch

filter

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

  • Returns a new filtered Cache based on the filter function

    Parameters

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

      Function used to determine what entries are in the new Cache

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

        • Parameters

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns Cache<string, GuildMember>

find

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

  • Finds an entry from this Cache

    Parameters

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

      Function used to find what you are looking for

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

        • Parameters

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns [string, GuildMember] | undefined

findKey

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

  • Finds a key from this Cache

    Parameters

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

      Function used to find what you are looking for

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

        • Parameters

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns string | undefined

findValue

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

  • Finds a value from this Cache

    Parameters

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

      Function used to find what you are looking for

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

        • Parameters

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns GuildMember | undefined

forEach

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

get

  • Parameters

    • key: string

    Returns GuildMember | undefined

has

  • has(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

map

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

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

    Type parameters

    • T

    Parameters

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

      Function to determine what is mapped to the new Array

        • Parameters

          Returns T

    • Optional thisArg: any

      Optional binding for the fn param

    Returns T[]

reduce

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

  • Reduces this cache into a singularity

    Type parameters

    • I

    Parameters

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

      The function to determine how this Cache is reduced

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

        • Parameters

          • accumulator: I
          • value: GuildMember
          • 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

resolveID

  • resolveID(data: unknown): string | null

set

some

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

  • Tests if some entries in this cache meets a condition

    Parameters

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

      The function to test the condition

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

        • Parameters

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns boolean

sort

  • Sorts entries in-place in this Cache

    Parameters

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

      Function to determine how this Cache should be sorted

    Returns this

sorted

  • Sorts entries in a new Cache

    Parameters

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

      Function to determine how the resulting Cache should be sorted

    Returns Cache<string, GuildMember>

sweep

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

  • Sweeps entries from this Cache

    Parameters

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

      Function used to determine what entries are swept

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

        • Parameters

          Returns boolean

    • Optional thisArg: any

      Optional binding for the fn param

    Returns number

toJSON

  • toJSON(): string[]

Generated using TypeDoc