Documentation/detritus-client/Collections

BaseClientGuildReferenceCache<K, V>class

Class Collections.BaseClientGuildReferenceCache from detritus-client.

On this page

Overview
Constructor1
Properties4
Accessors3
Methods12

import { Collections } from 'detritus-client';

Collections.BaseClientGuildReferenceCache;

Hierarchy

BaseCollectionMixin<K, V>BaseClientGuildReferenceCache

Type parameters

<K, V>

Subclasses

AutoModerationRules, Emojis, GuildScheduledEvents, Members, Roles, SoundboardSounds, StageInstances, Stickers

6 properties11 methodssrc/collections/basecollection.ts:243

Constructor

new BaseClientGuildReferenceCache

src/collections/basecollection.ts:249

new BaseClientGuildReferenceCache<K, V>(
  client: ShardClient,
  options?: boolean | BaseClientCollectionOptions,
)

Properties

client

ShardClient

enabled

boolean

key

string

Default ''

options

BaseCollectionOptions

Default {}

Accessors

[toStringTag]

string

get

Overrides BaseCollectionMixin.[toStringTag]

guilds

Guilds

get

size

number

get

Overrides BaseCollectionMixin.size

Methods

[iterator]()

src/collections/basecollection.ts:406

[iterator](): IterableIterator<[K, V]>

Overrides BaseCollectionMixin.[iterator]

clear()

src/collections/basecollection.ts:286

clear(): void

Overrides BaseCollectionMixin.clear

delete()

src/collections/basecollection.ts:293

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

forEach()

src/collections/basecollection.ts:314

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

Overrides BaseCollectionMixin.forEach

get()

src/collections/basecollection.ts:323

get(guildId: K | null | undefined, key: K): V | undefined

getOrInsert()

src/collections/basecollection.ts:342

getOrInsert(guildId: K, key: K, defaultValue: V): V

getOrInsertComputed()

src/collections/basecollection.ts:351

getOrInsertComputed(guildId: K, key: K, func: (key: K) => V): V

has()

src/collections/basecollection.ts:360

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

keys()

src/collections/basecollection.ts:388

keys(): IterableIterator<K>

Overrides BaseCollectionMixin.keys

set()

src/collections/basecollection.ts:379

set(guildId: K, key: K, value: V): this

setEnabled()

src/collections/basecollection.ts:282

setEnabled(value: boolean): void

values()

src/collections/basecollection.ts:397

values(): IterableIterator<V>

Overrides BaseCollectionMixin.values