Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormationMap<Data>

A specialised map that keeps track of formations. Most notably, it makes the formations runtime immutable

Type parameters

  • Data

Hierarchy

  • FormationMap

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

__@toStringTag

__@toStringTag: "Map" = "Map"

The string to use for the default toString function

Accessors

size

  • get size(): number

Methods

__@iterator

clear

  • clear(): void

delete

  • delete(id: GuidAccepted): boolean
  • Removes a stored formation

    Parameters

    • id: GuidAccepted

      the globally unique identification value to retrieve

    Returns boolean

    true if the formation was deleted

entries

forEach

  • forEach(callback: function, thisArg: any): void

get

  • Retrieves a stored formation

    Parameters

    • id: GuidAccepted

      the globally unique identification value to retrieve

    Returns IFormationImmutable<Data> | undefined

    the formation or undefined if not found

has

  • has(id: GuidAccepted): boolean
  • Determines if the map has a certain formation stored

    Parameters

    • id: GuidAccepted

      the globally unique identification value to search for

    Returns boolean

    true if the formation is available

keys

  • keys(): IterableIterator<string>
  • The stored formation identification values

    Returns IterableIterator<string>

    an iterator that will walk through the stored IDs

set

  • Stores a formation

    Parameters

    • id: GuidAccepted

      the globally unique identification value to retrieve

    • formation: IFormationImmutable<Data>

    Returns this

    the formation or undefined if not found

values