Class RoleManager

Hierarchy

BaseManager<Role>
- RoleManager

Index

Constructors

constructor

new RoleManager(client: Client, server: Server): RoleManager
Parameters
- client: Client
- server: Server
Returns RoleManager
Overrides BaseManager<Role>.constructor
- Defined in core/src/managers/RoleManager.ts:8

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Private` client

client: Client

`Private` server

server: Server

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

ordered

get ordered(): Role[]
Returns Role[]
- Defined in core/src/managers/RoleManager.ts:12

Methods

[iterator]

[iterator](): IterableIterator<[string, Role]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, Role]>
Inherited from BaseManager.__@iterator@11
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from BaseManager.clear
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:21

construct

construct(data: APIRole): Role
Parameters
- data: APIRole
Returns Role
- Defined in core/src/managers/RoleManager.ts:29

create

create(name: string, rank?: number): Promise<Role>
Parameters
- name: string
- Optional rank: number
Returns Promise<Role>
- Defined in core/src/managers/RoleManager.ts:16

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
Inherited from BaseManager.delete
- Defined in core/src/managers/BaseManager.ts:14

entries

entries(): IterableIterator<[string, Role]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, Role]>
Inherited from BaseManager.entries
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

filter

filter(...d: [predicate: ((value: Role, index: number, array: Role[]) => unknown), thisArg?: any]): Role[]
Parameters
- Rest ...d: [predicate: ((value: Role, index: number, array: Role[]) => unknown), thisArg?: any]
Returns Role[]
Inherited from BaseManager.filter
- Defined in core/src/managers/BaseManager.ts:27

find

find(...d: [predicate: ((value: Role, index: number, obj: Role[]) => unknown), thisArg?: any]): Role
Parameters
- Rest ...d: [predicate: ((value: Role, index: number, obj: Role[]) => unknown), thisArg?: any]
Returns Role
Inherited from BaseManager.find
- Defined in core/src/managers/BaseManager.ts:24

fireUpdate

fireUpdate(updated?: Role[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: Role[]
  
  The objects that caused this update.
Returns void
Inherited from BaseManager.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:67

forEach

forEach(callbackfn: ((value: Role, key: string, map: Map<string, Role>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: Role, key: string, map: Map<string, Role>) => void)
  - - (value: Role, key: string, map: Map<string, Role>): void
    - Parameters
      
      value: Role
      
      key: string
      
      map: Map<string, Role>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from BaseManager.forEach
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key: string): Role
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: string
Returns Role
Inherited from BaseManager.get
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:34

has

has(key: string): boolean
Returns
boolean indicating whether an element with the specified key exists or not.
Parameters
- key: string
Returns boolean
Inherited from BaseManager.has
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

items

items(): Role[]
Returns Role[]
Inherited from BaseManager.items
- Defined in core/src/managers/BaseManager.ts:20

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from BaseManager.keys
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

map

map<U>(callbackfn: ((value: Role, index: number, array: Role[]) => U)): U[]
Type Parameters
- U
Parameters
- callbackfn: ((value: Role, index: number, array: Role[]) => U)
  - - (value: Role, index: number, array: Role[]): U
    - Parameters
      
      value: Role
      
      index: number
      
      array: Role[]
      
      Returns U
Returns U[]
Inherited from BaseManager.map
- Defined in core/src/managers/BaseManager.ts:30

offUpdate

offUpdate(callback: MiniEmitterCallback<Role>): RoleManager
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<Role>
  
  The callback to stop listening for updates on.
Returns RoleManager
Inherited from BaseManager.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:58

onUpdate

onUpdate(callback: MiniEmitterCallback<Role>): RoleManager
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<Role>
  
  The callback to run when an update occurs.
Returns RoleManager
Inherited from BaseManager.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:49

set

set(key: string, value: Role): RoleManager
Parameters
- key: string
- value: Role
Returns RoleManager
Inherited from BaseManager.set
- Defined in core/src/managers/BaseManager.ts:9

sort

sort(...d: [compareFn?: ((a: Role, b: Role) => number)]): Role[]
Parameters
- Rest ...d: [compareFn?: ((a: Role, b: Role) => number)]
Returns Role[]
Inherited from BaseManager.sort
- Defined in core/src/managers/BaseManager.ts:33

update

update(): void
Returns void
- Defined in core/src/managers/RoleManager.ts:39

values

values(): IterableIterator<Role>
Returns an iterable of values in the map

Returns IterableIterator<Role>
Inherited from BaseManager.values
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class RoleManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

server: Server

Returns RoleManager

Properties

Readonly [toStringTag]

Private client

Private server

Readonly size

Returns

Static Readonly [species]

Accessors

ordered

Returns Role[]

Methods

[iterator]

Returns IterableIterator<[string, Role]>

clear

Returns void

construct

Parameters

data: APIRole

Returns Role

create

Parameters

name: string

Optional rank: number

Returns Promise<Role>

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, Role]>

filter

Parameters

Rest ...d: [predicate: ((value: Role, index: number, array: Role[]) => unknown), thisArg?: any]

Returns Role[]

find

Parameters

Rest ...d: [predicate: ((value: Role, index: number, obj: Role[]) => unknown), thisArg?: any]

Returns Role

fireUpdate

Parameters

Optional updated: Role[]

Returns void

forEach

Parameters

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

Parameters

value: Role

key: string

map: Map<string, Role>

Returns void

Optional thisArg: any

Returns void

get

Returns

Parameters

key: string

Returns Role

has

Returns

Parameters

key: string

Returns boolean

items

Returns Role[]

keys

Returns IterableIterator<string>

map

`Readonly` [toStringTag]

`Private` client

`Private` server

`Readonly` size

`Static` `Readonly` [species]

`Optional` rank: number

`Rest` ...d: [predicate: ((value: Role, index: number, array: Role[]) => unknown), thisArg?: any]

`Rest` ...d: [predicate: ((value: Role, index: number, obj: Role[]) => unknown), thisArg?: any]

`Optional` updated: Role[]

`Optional` thisArg: any

`Rest` ...d: [compareFn?: ((a: Role, b: Role) => number)]