Class MiniMapEmitter<T>

Type Parameters

  • T

Hierarchy

Constructors

constructor

Properties

[toStringTag] _callbacks size [species]

Methods

[iterator] clear delete entries fireUpdate forEach get has keys offUpdate onUpdate set values

Constructors

constructor

Properties

Readonly [toStringTag]

[toStringTag]: string

Private _callbacks

_callbacks: MiniEmitterCallback<T>[] = []

Readonly size

size: number

Returns

the number of elements in the Map.

Static Readonly [species]

[species]: MapConstructor

Methods

[iterator]

  • [iterator](): IterableIterator<[string, T]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[string, T]>

clear

  • Returns void

delete

  • Returns

    true if an element in the Map existed and has been removed, or false if the element does not exist.

    Parameters

    • key: string

    Returns boolean

entries

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[string, T]>

fireUpdate

  • Runs all of the callbacks for this emitter. (meant to run when an update occurs)

    Parameters

    • Optional updated: T[]

      The objects that caused this update.

    Returns void

forEach

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    Parameters

    • callbackfn: ((value: T, key: string, map: Map<string, T>) => void)
        • (value: T, key: string, map: Map<string, T>): void

        • Parameters

          • value: T
          • key: string
          • map: Map<string, T>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Returns

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

    Parameters

    • key: string

    Returns T

has

  • Returns

    boolean indicating whether an element with the specified key exists or not.

    Parameters

    • key: string

    Returns boolean

keys

  • Returns an iterable of keys in the map

    Returns IterableIterator<string>

offUpdate

onUpdate

set

  • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Parameters

    • key: string
    • value: T

    Returns MiniMapEmitter<T>

values

  • Returns an iterable of values in the map

    Returns IterableIterator<T>