Documentation/detritus-client/Collections

BaseClientCollectionCache<K, V>class

Basic Client Cache Collection, the ShardClient instance is attached to this

On this page

Overview
Constructor1
Properties4
Accessors2
Methods13

Basic Client Cache Collection, the ShardClient instance is attached to this

import { Collections } from 'detritus-client';

Collections.BaseClientCollectionCache;

Hierarchy

BaseCollectionMixin<K, V>BaseCollectionCache<K, V>BaseClientCollectionCache

Type parameters

<K, V>

Subclasses

ApplicationCommandPermissionsCache, TypingCollection, VoiceStates

2 properties1 method16 inheritedsrc/collections/basecollection.ts:215

Constructor

new BaseClientCollectionCache

src/collections/basecollection.ts:219

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

Properties

caches

BaseCollection<K, BaseCollection<K, V>>

readonly

Inherited from BaseCollectionCache.caches

client

ShardClient

enabled

boolean

options

BaseCollectionOptions

readonly

Default {}

Inherited from BaseCollectionCache.options

Accessors

[toStringTag]

string

get

Inherited from BaseCollectionCache.[toStringTag]

size

number

get

Inherited from BaseCollectionCache.size

Methods

[iterator]()

src/collections/basecollection.ts:161

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

Inherited from BaseCollectionCache.[iterator]

clear()

src/collections/basecollection.ts:37

clear(): void

Inherited from BaseCollectionCache.clear

delete()

src/collections/basecollection.ts:44

delete(cacheKey: K): boolean

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

Inherited from BaseCollectionCache.delete

forEach()

src/collections/basecollection.ts:68

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

Inherited from BaseCollectionCache.forEach

get()

src/collections/basecollection.ts:76

get(cacheKey: K): BaseCollection<K, V> | undefined

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

Inherited from BaseCollectionCache.get

getOrInsert()

src/collections/basecollection.ts:98

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

Inherited from BaseCollectionCache.getOrInsert

getOrInsertComputed()

src/collections/basecollection.ts:103

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

Inherited from BaseCollectionCache.getOrInsertComputed

has()

src/collections/basecollection.ts:108

has(cacheKey: K): boolean

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

Inherited from BaseCollectionCache.has

insertCache()

src/collections/basecollection.ts:130

insertCache(cacheKey: K): BaseCollection<K, V>

Inherited from BaseCollectionCache.insertCache

keys()

src/collections/basecollection.ts:145

keys(): IterableIterator<K>

Inherited from BaseCollectionCache.keys

set()

src/collections/basecollection.ts:139

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

Inherited from BaseCollectionCache.set

setEnabled()

src/collections/basecollection.ts:237

setEnabled(value: boolean): void

values()

src/collections/basecollection.ts:153

values(): IterableIterator<V>

Inherited from BaseCollectionCache.values