Class ValueCollection<Key, Value, SetValue>

A Key - Value Store with easy access functions

Example

const collection = new ValueCollection(...)

Since

2.5.0

Type Parameters

  • Key extends PropertyKey = PropertyKey
  • Value = any
  • SetValue = Value

Hierarchy

  • BaseCollection<Key, Value>
    • ValueCollection

Constructors

  • Create a new Value Collection

    Type Parameters

    • Key extends PropertyKey = PropertyKey
    • Value = any
    • SetValue = Value

    Parameters

    • Optional data: Record<Key, Value>
    • Optional parse: ((value) => Value)
    • allowModify: boolean = true
    • maxElements: number = Infinity

    Returns ValueCollection<Key, Value, SetValue>

    Example

    import { ValueCollection } from "rjweb-server"

    const collection = new ValueCollection()

    collection
    .set('name', 'beta')
    .set('key', 'value')

    collection.has('key') // true
    collection.has('ms') // false

    collection.json() // { name: 'beta', key: 'value' }

    for (const [ key, value ] of collection) {
    console.log(key, value)
    }

    collection.clear(['key'])

    collection.json() // { key: 'value' }

    Since

    2.5.0

Properties

allowModify: boolean
data: Map<Key, Value> = ...
maxElements: number
modifyFn: null | ((event, key, value) => any) = null

Type declaration

    • (event, key, value): any
    • Parameters

      • event: "set" | "delete" | "clear"
      • key: any
      • value: any

      Returns any

Accessors

  • get objectCount(): number
  • The Amount of Stored Objects

    Returns number

    Since

    2.7.2

    Deprecated

    use .size() instead

Methods

  • Object Iterator (similar to .forEach() but can be used in for ... of loops)

    Returns Iterator<[Key, Value], any, any>

    Since

    7.7.0

  • Loop over all Keys

    Parameters

    • callback: ((key, value, index) => any)
        • (key, value, index): any
        • Parameters

          Returns any

    • excluded: Key[] = []

    Returns this

    Since

    2.5.0

  • Search for a Key

    Parameters

    • callback: ((key, value, index) => boolean)
        • (key, value, index): boolean
        • Parameters

          Returns boolean

    Returns null | [Key, Value]

    Since

    9.3.0