Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Roles

Roles Reference Collection

Hierarchy

Index

Constructors

constructor

Properties

client

client: ShardClient

enabled

enabled: boolean

key

key: string = DetritusKeys[DiscordKeys.ROLES]

length

length: number

options

options: BaseCollectionOptions

Accessors

[Symbol.toStringTag]

  • get [Symbol.toStringTag](): string

guilds

size

  • get size(): number

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<[string, Role]>

clear

  • clear(): void

delete

  • delete(guildId: string | null | undefined, key: string): boolean
  • Parameters

    • guildId: string | null | undefined
    • key: string

    Returns boolean

entries

  • entries(): IterableIterator<[string, Role]>
  • Returns IterableIterator<[string, Role]>

every

  • every(func: function): boolean
  • Parameters

    • func: function
        • (v: Role, k: string): boolean
        • Parameters

          Returns boolean

    Returns boolean

filter

  • filter(func: function): Array<Role>
  • Parameters

    • func: function
        • (v: Role, k: string): boolean
        • Parameters

          Returns boolean

    Returns Array<Role>

find

  • find(func: function): Role | undefined
  • Parameters

    • func: function
        • (v: Role, k: string): boolean
        • Parameters

          Returns boolean

    Returns Role | undefined

first

  • first(): Role | undefined
  • Returns Role | undefined

forEach

  • forEach(func: function, thisArg?: any): void
  • Parameters

    • func: function
        • (v: Role, k: string, map: Map<string, Role>): void
        • Parameters

          • v: Role
          • k: string
          • map: Map<string, Role>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(guildId: string | null | undefined, key: string): Role | undefined
  • Parameters

    • guildId: string | null | undefined
    • key: string

    Returns Role | undefined

has

  • has(guildId: string | null | undefined, key: string): boolean
  • Parameters

    • guildId: string | null | undefined
    • key: string

    Returns boolean

insert

  • insert(role: Role): void
  • Parameters

    Returns void

join

  • join(separator?: undefined | string): string
  • Parameters

    • Optional separator: undefined | string

    Returns string

keys

  • keys(): IterableIterator<string>
  • Returns IterableIterator<string>

map

  • map(func: function): Array<any>
  • Parameters

    • func: function
        • (v: Role, k: string): any
        • Parameters

          Returns any

    Returns Array<any>

reduce

  • reduce(func: function, initialValue?: any): any
  • Parameters

    • func: function
        • (intial: any, v: Role): any
        • Parameters

          • intial: any
          • v: Role

          Returns any

    • Optional initialValue: any

    Returns any

set

  • set(guildId: string, key: string, value: Role): this

setEnabled

  • setEnabled(value: boolean): void

some

  • some(func: function): boolean
  • Parameters

    • func: function
        • (v: Role, k: string): boolean
        • Parameters

          Returns boolean

    Returns boolean

sort

  • sort(func?: undefined | function): Array<Role>
  • Parameters

    • Optional func: undefined | function

    Returns Array<Role>

toArray

  • toArray(): Array<Role>
  • Returns Array<Role>

toJSON

  • toJSON(): Array<Role>
  • Returns Array<Role>

toString

  • toString(): string
  • Returns string

values

  • values(): IterableIterator<Role>

Generated using TypeDoc