Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrderedMap<K, V>

Type parameters

  • K = unknown

  • V = unknown

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly size

size: number

Methods

clear

  • clear(): void

  • Returns void

delete

  • delete(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

entries

  • Returns Iterator<[K, V]>

firstEntry

  • firstEntry(): undefined | [K, V]

  • Returns undefined | [K, V]

firstKey

  • firstKey(): undefined | K

  • Returns undefined | K

firstValue

  • firstValue(): undefined | V

  • Returns undefined | V

forEach

  • forEach<T>(callback: (key: K, value: V) => void | T): undefined | T
  • forEach<T, S>(callback: (key: K, value: V) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    • callback: (key: K, value: V) => void | T
        • (key: K, value: V): void | T

        • Parameters

          • key: K
          • value: V

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (key: K, value: V) => void | T
        • (key: K, value: V): void | T

        • Parameters

          • key: K
          • value: V

          Returns void | T

    • thisArg: S

    Returns undefined | T

get

  • get(key: K): undefined | V

  • Parameters

    • key: K

    Returns undefined | V

getEntry

  • getEntry(index: number): undefined | [K, V]

  • Parameters

    • index: number

    Returns undefined | [K, V]

has

  • has(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

isEmpty

  • isEmpty(): boolean

  • Returns boolean

keys

  • Returns Iterator<K>

lastEntry

  • lastEntry(): undefined | [K, V]

  • Returns undefined | [K, V]

lastKey

  • lastKey(): undefined | K

  • Returns undefined | K

lastValue

  • lastValue(): undefined | V

  • Returns undefined | V

nextEntry

  • nextEntry(key: K): undefined | [K, V]

  • Parameters

    • key: K

    Returns undefined | [K, V]

nextKey

  • nextKey(key: K): undefined | K

  • Parameters

    • key: K

    Returns undefined | K

nextValue

  • nextValue(key: K): undefined | V

  • Parameters

    • key: K

    Returns undefined | V

previousEntry

  • previousEntry(key: K): undefined | [K, V]

  • Parameters

    • key: K

    Returns undefined | [K, V]

previousKey

  • previousKey(key: K): undefined | K

  • Parameters

    • key: K

    Returns undefined | K

previousValue

  • previousValue(key: K): undefined | V

  • Parameters

    • key: K

    Returns undefined | V

set

  • Parameters

    • key: K
    • newValue: V

    Returns OrderedMap<K, V>

values

  • Returns Iterator<V>

Generated using TypeDoc