Options
All
  • Public
  • Public/Protected
  • All
Menu

Basic Client Collection, the ShardClient instance is attached to this

Type parameters

  • K

  • V

Hierarchy

Index

Constructors

constructor

Properties

Optional _lastUsed

_lastUsed: Map<K, number>

Readonly cache

cache: Map<K, V>

client

client: ShardClient

enabled

enabled: boolean

Optional expire

expire: number

Optional interval

interval: Interval

intervalTime

intervalTime: number

limit

limit: number

Accessors

[Symbol.toStringTag]

  • get [Symbol.toStringTag](): string
  • Returns string

lastUsed

  • get lastUsed(): Map<K, number>
  • Returns Map<K, number>

length

  • get length(): number
  • Returns number

shouldStartInterval

  • get shouldStartInterval(): boolean
  • Returns boolean

size

  • get size(): number
  • Returns number

Methods

[Symbol.iterator]

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

clear

  • clear(): void
  • Returns void

clone

delete

  • delete(key: K): boolean
  • Parameters

    • key: K

    Returns boolean

entries

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

every

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

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

          • v: V
          • k: K

          Returns boolean

    Returns boolean

filter

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

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

          • v: V
          • k: K

          Returns boolean

    Returns V[]

find

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

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

          • v: V
          • k: K

          Returns boolean

    Returns undefined | V

first

  • first(): undefined | V
  • Returns undefined | V

forEach

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

    • func: (v: V, k: K, map: Map<K, V>) => void
        • (v: V, k: K, map: Map<K, V>): void
        • Parameters

          • v: V
          • k: K
          • map: Map<K, V>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: K): undefined | V
  • Parameters

    • key: K

    Returns undefined | V

has

  • has(key: K): boolean
  • Parameters

    • key: K

    Returns boolean

join

  • join(separator?: string): string
  • Parameters

    • Optional separator: string

    Returns string

keys

  • keys(): IterableIterator<K>
  • Returns IterableIterator<K>

map

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

    • func: (v: V, k: K) => any
        • (v: V, k: K): any
        • Parameters

          • v: V
          • k: K

          Returns any

    Returns any[]

reduce

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

    • func: (intial: any, v: V) => any
        • (intial: any, v: V): any
        • Parameters

          • intial: any
          • v: V

          Returns any

    • Optional initialValue: any

    Returns any

set

setEnabled

  • setEnabled(value: boolean): void

setExpire

setIntervalTimeout

some

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

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

          • v: V
          • k: K

          Returns boolean

    Returns boolean

sort

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

    • Optional func: (x: V, y: V) => number
        • (x: V, y: V): number
        • Parameters

          • x: V
          • y: V

          Returns number

    Returns V[]

startInterval

  • startInterval(): void

stopInterval

  • stopInterval(): void

toArray

  • toArray(): V[]
  • Returns V[]

toJSON

  • toJSON(): V[]
  • Returns V[]

toString

  • toString(): string
  • Returns string

values

  • values(): IterableIterator<V>
  • Returns IterableIterator<V>

Generated using TypeDoc