RoleStore | @klasa/core

The store for guild roles.

since: 0.0.1

Hierarchy

DataStore<Role>
- RoleStore

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RoleStore(client: Client, guild: Guild): RoleStore

Overrides DataStore.constructor
- Defined in src/lib/caching/stores/RoleStore.ts:20
Builds the store.

since

0.0.1

Parameters
- client: Client
  
  The client this store belongs to.
- guild: Guild
  
  The guild this store belongs to.
Returns RoleStore

Properties

Private #limit

#limit: number

The cache limit of this DataStore

Protected Readonly Holds

Holds: Constructor<Role>

Readonly client

client: Client

Readonly guild

guild: Guild

The guild this store belongs to.

since: 0.0.1

Readonly size

size: number

Accessors

first

get first(): [string, Role] | null

Inherited from Store.first
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:10
The first item in this Cache

Returns [string, Role] | null

firstKey

get firstKey(): string | null

Inherited from Store.firstKey
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:18
The first key of this cache

Returns string | null

firstValue

get firstValue(): Role | null

Inherited from Store.firstValue
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:14
The first value of this cache

Returns Role | null

last

get last(): [string, Role] | null

Inherited from Store.last
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:22
The last item in this cache

Returns [string, Role] | null

lastKey

get lastKey(): string | null

Inherited from Store.lastKey
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:30
The last key of this cache

Returns string | null

lastValue

get lastValue(): Role | null

Inherited from Store.lastValue
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:26
The last value of this cache

Returns Role | null

Static [Symbol.species]

get [Symbol.species](): typeof Cache

Inherited from GuildChannelStore.[Symbol.species]
- Defined in src/lib/caching/stores/base/DataStore.ts:72
Defines the extensibility of DataStores

Returns typeof Cache

Methods

Protected _add

_add(data: APIRoleData): Role

Overrides MessageReactionStore._add
- Defined in src/lib/caching/stores/RoleStore.ts:92
Adds a new structure to this DataStore

Parameters
- data: APIRoleData
  
  The data packet to add
Returns Role

add

add(data?: RoleStoreAddOptions, requestOptions?: RequestOptions): Promise<Role>

- Defined in src/lib/caching/stores/RoleStore.ts:48
Creates a new role for the guild.

since

0.0.1

see

https://discord.com/developers/docs/resources/guild#create-guild-role

Parameters
- Default value data: RoleStoreAddOptions = {}
  
  The role settings.
- Default value requestOptions: RequestOptions = {}
  
  The additional request options.
Returns Promise<Role>

clear

clear(): void

Inherited from Store.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:22
Returns void

clone

clone(): Cache<string, Role>

Inherited from Store.clone
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:89
Returns a shallow clone of this Cache

Returns Cache<string, Role>

concat

concat(...caches: Cache<string, Role>[]): Cache<string, Role>

Inherited from Store.concat
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:94
Returns a new Cache with this and other caches together

Parameters
- Rest ...caches: Cache<string, Role>[]
  
  Other caches to include in the new cache
Returns Cache<string, Role>

delete

delete(key: string): boolean

Inherited from GuildChannelStore.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters
- key: string
Returns boolean

equals

equals(cache: Cache<string, Role>): boolean

Inherited from Store.equals
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:99
Naive equality compare function

Parameters
- cache: Cache<string, Role>
  
  The cache to compare this against
Returns boolean

every

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

Inherited from Store.every
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:78
Tests if every entry in this cache meets a condition

Parameters
- fn: (value: Role, key: string, map: this) => boolean
  
  The function to test the condition
  - - (value: Role, key: string, map: this): boolean
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns boolean
- Optional thisArg: any
  
  Optional binding for the fn param
Returns boolean

fetch

fetch(): Promise<this>

- Defined in src/lib/caching/stores/RoleStore.ts:82
Returns the list of roles as updated from Discord.

since

0.0.1

see

https://discord.com/developers/docs/resources/guild#get-guild-roles

Returns Promise<this>

filter

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

Inherited from Store.filter
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:60
Returns a new filtered Cache based on the filter function

Parameters
- fn: (value: Role, key: string, map: this) => boolean
  
  Function used to determine what entries are in the new Cache
  - - (value: Role, key: string, map: this): boolean
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns boolean
- Optional thisArg: any
  
  Optional binding for the fn param
Returns Cache<string, Role>

find

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

Inherited from Store.find
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:36
Finds an entry from this Cache

Parameters
- fn: (value: Role, key: string, map: this) => boolean
  
  Function used to find what you are looking for
  - - (value: Role, key: string, map: this): boolean
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns boolean
- Optional thisArg: any
  
  Optional binding for the fn param
Returns [string, Role] | undefined

findKey

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

Inherited from Store.findKey
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:42
Finds a key from this Cache

Parameters
- fn: (value: Role, key: string, map: this) => boolean
  
  Function used to find what you are looking for
  - - (value: Role, key: string, map: this): boolean
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns boolean
- Optional thisArg: any
  
  Optional binding for the fn param
Returns string | undefined

findValue

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

Inherited from Store.findValue
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:48
Finds a value from this Cache

Parameters
- fn: (value: Role, key: string, map: this) => boolean
  
  Function used to find what you are looking for
  - - (value: Role, key: string, map: this): boolean
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns boolean
- Optional thisArg: any
  
  Optional binding for the fn param
Returns Role | undefined

forEach

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

Inherited from Store.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24
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

get

get(key: string): Role | undefined

Inherited from Store.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25
Parameters
- key: string
Returns Role | undefined

has

has(key: string): boolean

Inherited from Store.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: string
Returns boolean

highest

highest(): Role | undefined

- Defined in src/lib/caching/stores/RoleStore.ts:37
Gets the highest role from this store.

since

0.0.1

Returns Role | undefined

map

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

Inherited from Store.map
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:66
Maps this Cache to an array (like Array#map())

Type parameters
- T
Parameters
- fn: (value: Role, key: string, map: this) => T
  
  Function to determine what is mapped to the new Array
  - - (value: Role, key: string, map: this): T
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns T
- Optional thisArg: any
  
  Optional binding for the fn param
Returns T[]

modifyPositions

modifyPositions(data: keyof RoleStorePositionData[], requestOptions?: RequestOptions): Promise<this>

- Defined in src/lib/caching/stores/RoleStore.ts:72
Modifies the positions of the roles.

since

0.0.1

see

https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

Parameters
- data: keyof RoleStorePositionData[]
  
  The set of roles and their positions for the guild.
- Default value requestOptions: RequestOptions = {}
  
  The additional request options.
Returns Promise<this>

reduce

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

Inherited from Store.reduce
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:85
Reduces this cache into a singularity

Type parameters
- I
Parameters
- fn: (accumulator: I, value: Role, key: string, map: this) => I
  
  The function to determine how this Cache is reduced
  - - (accumulator: I, value: Role, key: string, map: this): I
    - Parameters
      - accumulator: I
      - value: Role
      - key: string
      - map: this
      Returns I
- initialValue: I
  
  The initial value
- Optional thisArg: any
  
  Optional binding for the fn param
Returns I

remove

remove(roleID: string, requestOptions?: RequestOptions): Promise<this>

- Defined in src/lib/caching/stores/RoleStore.ts:60
Deletes a role from the guild.

since

0.0.1

see

https://discord.com/developers/docs/resources/guild#delete-guild-role

Parameters
- roleID: string
  
  The role ID to delete.
- Default value requestOptions: RequestOptions = {}
  
  The additional request options.
Returns Promise<this>

resolve

resolve(data: unknown): Role | null

Inherited from GuildChannelStore.resolve
- Defined in src/lib/caching/stores/base/DataStore.ts:27
Resolves data into Structures

Parameters
- data: unknown
  
  The data to resolve
Returns Role | null

resolveID

resolveID(data: unknown): string | null

Inherited from GuildChannelStore.resolveID
- Defined in src/lib/caching/stores/base/DataStore.ts:37
Resolves data into ids

Parameters
- data: unknown
  
  The data to resolve
Returns string | null

set

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

Inherited from GuildChannelStore.set

Overrides Map.set
- Defined in src/lib/caching/stores/base/DataStore.ts:48
Sets a value to this DataStore taking into account the cache limit.

Parameters
- key: string
  
  The key of the value you are setting
- value: Role
  
  The value for the key you are setting
Returns this

some

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

Inherited from Store.some
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:72
Tests if some entries in this cache meets a condition

Parameters
- fn: (value: Role, key: string, map: this) => boolean
  
  The function to test the condition
  - - (value: Role, key: string, map: this): boolean
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns boolean
- Optional thisArg: any
  
  Optional binding for the fn param
Returns boolean

sort

sort(compareFunction?: undefined | ((v0: Role, v1: Role, k0?: K, k1?: K) => number)): this

Inherited from Store.sort
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:104
Sorts entries in-place in this Cache

Parameters
- Optional compareFunction: undefined | ((v0: Role, v1: Role, k0?: K, k1?: K) => number)
  
  Function to determine how this Cache should be sorted
Returns this

sorted

sorted(compareFunction?: undefined | ((v0: Role, v1: Role, k0?: K, k1?: K) => number)): Cache<string, Role>

Inherited from Store.sorted
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:109
Sorts entries in a new Cache

Parameters
- Optional compareFunction: undefined | ((v0: Role, v1: Role, k0?: K, k1?: K) => number)
  
  Function to determine how the resulting Cache should be sorted
Returns Cache<string, Role>

sweep

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

Inherited from Store.sweep
- Defined in node_modules/@klasa/cache/dist/Cache.d.ts:54
Sweeps entries from this Cache

Parameters
- fn: (value: Role, key: string, map: this) => boolean
  
  Function used to determine what entries are swept
  - - (value: Role, key: string, map: this): boolean
    - Parameters
      - value: Role
      - key: string
      - map: this
      Returns boolean
- Optional thisArg: any
  
  Optional binding for the fn param
Returns number

toJSON

toJSON(): string[]

Inherited from GuildChannelStore.toJSON
- Defined in src/lib/caching/stores/base/DataStore.ts:79
The JSON representation of this object.

Returns string[]

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

guild: Guild

Returns RoleStore

Properties

Private #limit

Protected Readonly Holds

Readonly client

Readonly guild

Readonly size

Accessors

first

Returns [string, Role] | null

firstKey

Returns string | null

firstValue

Returns Role | null

last

Returns [string, Role] | null

lastKey

Returns string | null

lastValue

Returns Role | null

Static [Symbol.species]

Returns typeof Cache

Methods

Protected _add

Parameters

data: APIRoleData

Returns Role

add

Parameters

Default value data: RoleStoreAddOptions = {}

Default value requestOptions: RequestOptions = {}

Returns Promise<Role>

clear

Returns void

clone

Returns Cache<string, Role>

concat

Parameters

Rest ...caches: Cache<string, Role>[]

Returns Cache<string, Role>

delete

Parameters

key: string

Returns boolean

equals

Parameters

cache: Cache<string, Role>

Returns boolean

every

Parameters

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

Parameters

value: Role

key: string

map: this

Returns boolean

Optional thisArg: any

Returns boolean

fetch

Returns Promise<this>

filter

Parameters

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

Parameters

value: Role

key: string

map: this

Returns boolean

Optional thisArg: any