Documentation/detritus-client/Collections

BaseCollectionCache<K, V>class

Class Collections.BaseCollectionCache from detritus-client.

On this page

Overview
Constructor1
Properties2
Accessors2
Methods12

import { Collections } from 'detritus-client';

Collections.BaseCollectionCache;

Hierarchy

BaseCollectionMixin<K, V>BaseCollectionCache

Type parameters

<K, V>

Subclasses

BaseClientCollectionCache

3 properties11 methodssrc/collections/basecollection.ts:15

Constructor

new BaseCollectionCache

src/collections/basecollection.ts:19

new BaseCollectionCache<K, V>(options?: BaseCollectionOptions)

Properties

caches

BaseCollection<K, BaseCollection<K, V>>

readonly

options

BaseCollectionOptions

readonly

Default {}

Accessors

[toStringTag]

string

get

Overrides BaseCollectionMixin.[toStringTag]

size

number

get

Overrides BaseCollectionMixin.size

Methods

[iterator]()

src/collections/basecollection.ts:161

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

Overrides BaseCollectionMixin.[iterator]

clear()

src/collections/basecollection.ts:37

clear(): void

Overrides BaseCollectionMixin.clear

delete()

src/collections/basecollection.ts:44

delete(cacheKey: K): boolean

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

forEach()

src/collections/basecollection.ts:68

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

Overrides BaseCollectionMixin.forEach

get()

src/collections/basecollection.ts:76

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

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

getOrInsert()

src/collections/basecollection.ts:98

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

getOrInsertComputed()

src/collections/basecollection.ts:103

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

has()

src/collections/basecollection.ts:108

has(cacheKey: K): boolean

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

insertCache()

src/collections/basecollection.ts:130

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

keys()

src/collections/basecollection.ts:145

keys(): IterableIterator<K>

Overrides BaseCollectionMixin.keys

set()

src/collections/basecollection.ts:139

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

values()

src/collections/basecollection.ts:153

values(): IterableIterator<V>

Overrides BaseCollectionMixin.values