BaseCollection<K, V>class

A Map with array-style helpers, an optional size limit (least recently used are evicted first) and optional expiry.

On this page

Overview
Constructor1
Properties7
Accessors5
Methods33

import { BaseCollection } from 'detritus-utils';

Hierarchy

BaseCollectionMixin<K, V>BaseCollection

Type parameters

<K, V>

8 properties19 methods14 inheritedsrc/basecollection.ts:128

Constructor

new BaseCollection

src/basecollection.ts:138

new BaseCollection<K, V>(__namedParameters?: BaseCollectionOptions)

Properties

_lastUsed?

Map<K, number>

optional

_order?

Map<K, true>

optional

cache

Map<K, V>

readonly

expire?

number

optional

interval?

Interval

optional

Default undefined

intervalTime

number

Default 5000

limit

number

Default Infinity

Accessors

[toStringTag]

string

get

Overrides BaseCollectionMixin.[toStringTag]

lastUsed

Map<K, number>

get

length

number

get

Inherited from BaseCollectionMixin.length

shouldStartInterval

boolean

get

size

number

get

Overrides BaseCollectionMixin.size

Methods

[iterator]()

src/basecollection.ts:417

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

Overrides BaseCollectionMixin.[iterator]

clear()

src/basecollection.ts:263

clear(): void

Overrides BaseCollectionMixin.clear

clone()

src/basecollection.ts:274

clone(): BaseCollection<K, V>

delete()

src/basecollection.ts:284

delete(key: K): boolean

entries()

src/basecollection.ts:17

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

Inherited from BaseCollectionMixin.entries

every()

src/basecollection.ts:21

every(func: (v: V, k: K) => boolean): boolean

Inherited from BaseCollectionMixin.every

evict()

src/basecollection.ts:371

evict(room?: number): void

Evicts the least recently used items until there's room free under the limit

Parameters

room?

number

Default 0

filter()

src/basecollection.ts:30

filter(func: (v: V, k: K) => boolean): V[]

Inherited from BaseCollectionMixin.filter

find()

src/basecollection.ts:40

find(func: (v: V, k: K) => boolean): V | undefined

Inherited from BaseCollectionMixin.find

first()

src/basecollection.ts:49

first(): V | undefined

Inherited from BaseCollectionMixin.first

forEach()

src/basecollection.ts:298

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

Overrides BaseCollectionMixin.forEach

get()

src/basecollection.ts:302

get(key: K): V | undefined

getOrder()

src/basecollection.ts:392

getOrder(): Map<K, true>

The recency order (least recently used first), synced with the cache keys added before limit was set (or while it was Infinity) aren't tracked yet, so they count as the least recently used

getOrInsert()

src/basecollection.ts:318

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

getOrInsertComputed()

src/basecollection.ts:326

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

has()

src/basecollection.ts:335

has(key: K): boolean

join()

src/basecollection.ts:59

join(separator?: string): string

Inherited from BaseCollectionMixin.join

keys()

src/basecollection.ts:339

keys(): IterableIterator<K>

Overrides BaseCollectionMixin.keys

map()

src/basecollection.ts:63

map(func: (v: V, k: K) => any): any[]

Inherited from BaseCollectionMixin.map

reduce()

src/basecollection.ts:71

reduce(func: (intial: any, v: V) => any, initialValue?: any): any

Inherited from BaseCollectionMixin.reduce

set()

src/basecollection.ts:343

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

setExpire()

src/basecollection.ts:186

setExpire(value: number): this

setIntervalTimeout()

src/basecollection.ts:216

setIntervalTimeout(value: number): this

setLimit()

src/basecollection.ts:210

setLimit(value: number): this

some()

src/basecollection.ts:79

some(func: (v: V, k: K) => boolean): boolean

Inherited from BaseCollectionMixin.some

sort()

src/basecollection.ts:88

sort(func?: (x: V, y: V) => number): V[]

Inherited from BaseCollectionMixin.sort

startInterval()

src/basecollection.ts:228

startInterval(): void

stopInterval()

src/basecollection.ts:252

stopInterval(): void

toArray()

src/basecollection.ts:92

toArray(): V[]

Inherited from BaseCollectionMixin.toArray

toJSON()

src/basecollection.ts:96

toJSON(): V[]

Inherited from BaseCollectionMixin.toJSON

toString()

src/basecollection.ts:100

toString(): string

Inherited from BaseCollectionMixin.toString

touch()

src/basecollection.ts:176

touch(key: K): void

values()

src/basecollection.ts:413

values(): IterableIterator<V>

Overrides BaseCollectionMixin.values