Class Roles

Roles Reference Collection

Hierarchy

BaseClientGuildReferenceCache<string, Role>
- Roles

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Roles(client: ShardClient, options?: BaseClientCollectionOptions): Roles

Inherited from BaseClientGuildReferenceCache.constructor
- Defined in src/collections/basecollection.ts:234
Parameters
- client: ShardClient
- Default value options: BaseClientCollectionOptions = {}
Returns Roles

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

Overrides BaseClientGuildReferenceCache.[Symbol.toStringTag]
- Defined in src/collections/roles.ts:33
Returns string

guilds

get guilds(): Guilds

Inherited from BaseClientGuildReferenceCache.guilds
- Defined in src/collections/basecollection.ts:253
Returns Guilds

size

get size(): number

Inherited from BaseClientGuildReferenceCache.size

Overrides BaseCollectionMixin.size
- Defined in src/collections/basecollection.ts:257
Returns number

Methods

[Symbol.iterator]

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

Inherited from BaseClientGuildReferenceCache.[Symbol.iterator]

Overrides BaseCollectionMixin.[Symbol.iterator]
- Defined in src/collections/basecollection.ts:372
Returns IterableIterator<[string, Role]>

clear

clear(): void

Inherited from BaseClientGuildReferenceCache.clear

Overrides BaseCollectionMixin.clear
- Defined in src/collections/basecollection.ts:270
Returns void

delete

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

Inherited from BaseClientGuildReferenceCache.delete
- Defined in src/collections/basecollection.ts:277
Parameters
- guildId: string | null | undefined
- key: string
Returns boolean

entries

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

Inherited from BaseCollectionMixin.entries
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:6
Returns IterableIterator<[string, Role]>

every

every(func: function): boolean

Inherited from BaseCollectionMixin.every
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:7
Parameters
- func: function
  - - (v: Role, k: string): boolean
    - Parameters
      - v: Role
      - k: string
      Returns boolean
Returns boolean

filter

filter(func: function): Array<Role>

Inherited from BaseCollectionMixin.filter
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:8
Parameters
- func: function
  - - (v: Role, k: string): boolean
    - Parameters
      - v: Role
      - k: string
      Returns boolean
Returns Array<Role>

find

find(func: function): Role | undefined

Inherited from BaseCollectionMixin.find
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:9
Parameters
- func: function
  - - (v: Role, k: string): boolean
    - Parameters
      - v: Role
      - k: string
      Returns boolean
Returns Role | undefined

first

first(): Role | undefined

Inherited from BaseCollectionMixin.first
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:10
Returns Role | undefined

forEach

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

Inherited from BaseClientGuildReferenceCache.forEach

Overrides BaseCollectionMixin.forEach
- Defined in src/collections/basecollection.ts:298
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

Inherited from BaseClientGuildReferenceCache.get
- Defined in src/collections/basecollection.ts:307
Parameters
- guildId: string | null | undefined
- key: string
Returns Role | undefined

has

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

Inherited from BaseClientGuildReferenceCache.has
- Defined in src/collections/basecollection.ts:326
Parameters
- guildId: string | null | undefined
- key: string
Returns boolean

insert

insert(role: Role): void

- Defined in src/collections/roles.ts:24
Parameters
- role: Role
Returns void

join

join(separator?: undefined | string): string

Inherited from BaseCollectionMixin.join
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:12
Parameters
- Optional separator: undefined | string
Returns string

keys

keys(): IterableIterator<string>

Inherited from BaseClientGuildReferenceCache.keys

Overrides BaseCollectionMixin.keys
- Defined in src/collections/basecollection.ts:354
Returns IterableIterator<string>

map

map(func: function): Array<any>

Inherited from BaseCollectionMixin.map
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:13
Parameters
- func: function
  - - (v: Role, k: string): any
    - Parameters
      - v: Role
      - k: string
      Returns any
Returns Array<any>

reduce

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

Inherited from BaseCollectionMixin.reduce
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:14
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

Inherited from BaseClientGuildReferenceCache.set
- Defined in src/collections/basecollection.ts:345
Parameters
- guildId: string
- key: string
- value: Role
Returns this

setEnabled

setEnabled(value: boolean): void

Inherited from BaseClientGuildReferenceCache.setEnabled
- Defined in src/collections/basecollection.ts:266
Parameters
- value: boolean
Returns void

some

some(func: function): boolean

Inherited from BaseCollectionMixin.some
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:15
Parameters
- func: function
  - - (v: Role, k: string): boolean
    - Parameters
      - v: Role
      - k: string
      Returns boolean
Returns boolean

sort

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

Inherited from BaseCollectionMixin.sort
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:16
Parameters
- Optional func: undefined | function
Returns Array<Role>

toArray

toArray(): Array<Role>

Inherited from BaseCollectionMixin.toArray
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:17
Returns Array<Role>

toJSON

toJSON(): Array<Role>

Inherited from BaseCollectionMixin.toJSON
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:18
Returns Array<Role>

toString

toString(): string

Inherited from BaseCollectionMixin.toString
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:19
Returns string

values

values(): IterableIterator<Role>

Inherited from BaseClientGuildReferenceCache.values

Overrides BaseCollectionMixin.values
- Defined in src/collections/basecollection.ts:363
Returns IterableIterator<Role>

Generated using TypeDoc