Class Roles

Roles Reference Collection

Hierarchy

BaseClientGuildReferenceCache<string, Role>
- Roles

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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

Properties

client

client: ShardClient

enabled

enabled: boolean

key

key: string = ...

options

options: BaseCollectionOptions = {}

Accessors

[Symbol.toStringTag]

get [Symbol.toStringTag](): string

- Defined in src/collections/roles.ts:33
Returns string

guilds

get guilds(): Guilds

- Defined in src/collections/basecollection.ts:259
Returns Guilds

length

get length(): number

- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:3
Returns number

size

get size(): number

- Defined in src/collections/basecollection.ts:263
Returns number

Methods

[Symbol.iterator]

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

Inherited from BaseClientGuildReferenceCache.[Symbol.iterator]
- Defined in src/collections/basecollection.ts:378
Returns IterableIterator<[string, Role]>

clear

clear(): void

Inherited from BaseClientGuildReferenceCache.clear
- Defined in src/collections/basecollection.ts:276
Returns void

delete

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

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

entries

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

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

every

every(func: (v: Role, k: string) => boolean): boolean

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

filter

filter(func: (v: Role, k: string) => boolean): Role[]

Inherited from BaseClientGuildReferenceCache.filter
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:8
Parameters
- func: (v: Role, k: string) => boolean
  - - (v: Role, k: string): boolean
    - Parameters
      - v: Role
      - k: string
      Returns boolean
Returns Role[]

find

find(func: (v: Role, k: string) => boolean): undefined | Role

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

first

first(): undefined | Role

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

forEach

forEach(func: (v: Role, k: string, map: Map<string, Role>) => void, thisArg?: any): void

Inherited from BaseClientGuildReferenceCache.forEach
- Defined in src/collections/basecollection.ts:304
Parameters
- func: (v: Role, k: string, map: Map<string, Role>) => void
  - - (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: undefined | null | string, key: string): undefined | Role

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

has

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

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

insert

insert(role: Role): void

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

join

join(separator?: string): string

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

keys

keys(): IterableIterator<string>

Inherited from BaseClientGuildReferenceCache.keys
- Defined in src/collections/basecollection.ts:360
Returns IterableIterator<string>

map

map(func: (v: Role, k: string) => any): any[]

Inherited from BaseClientGuildReferenceCache.map
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:13
Parameters
- func: (v: Role, k: string) => any
  - - (v: Role, k: string): any
    - Parameters
      - v: Role
      - k: string
      Returns any
Returns any[]

reduce

reduce(func: (intial: any, v: Role) => any, initialValue?: any): any

Inherited from BaseClientGuildReferenceCache.reduce
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:14
Parameters
- func: (intial: any, v: Role) => any
  - - (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): Roles

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

setEnabled

setEnabled(value: boolean): void

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

some

some(func: (v: Role, k: string) => boolean): boolean

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

sort

sort(func?: (x: Role, y: Role) => number): Role[]

Inherited from BaseClientGuildReferenceCache.sort
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:16
Parameters
- Optional func: (x: Role, y: Role) => number
  - - (x: Role, y: Role): number
    - Parameters
      - x: Role
      - y: Role
      Returns number
Returns Role[]

toArray

toArray(): Role[]

Inherited from BaseClientGuildReferenceCache.toArray
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:17
Returns Role[]

toJSON

toJSON(): Role[]

Inherited from BaseClientGuildReferenceCache.toJSON
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:18
Returns Role[]

toString

toString(): string

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

values

values(): IterableIterator<Role>

Inherited from BaseClientGuildReferenceCache.values
- Defined in src/collections/basecollection.ts:369
Returns IterableIterator<Role>

Generated using TypeDoc