Class: HostMap

HostMap()

Represents an associative-array of hosts that can be iterated. It creates an internal copy when adding or removing, making it safe to iterate using the values() method within async operations.

Constructor

new HostMap()

Source:

Extends

  • events.EventEmitter

Methods

clear() → {Array.<Host>}

Removes all items from the map.

Source:
Returns:

The previous items

Type
Array.<Host>

forEach(callback)

Executes a provided function once per map element.

Parameters:
Name Type Description
callback
Source:

get(key) → {Host}

Gets a host by key or undefined if not found.

Parameters:
Name Type Description
key String
Source:
Returns:
Type
Host

keys() → {Array.<String>}

Returns an array of host addresses.

Source:
Returns:
Type
Array.<String>

remove(key)

Removes an item from the map.

Parameters:
Name Type Description
key String

The key of the host
Source:
Fires:
  • HostMap#event:remove

removeMultiple(keys)

Removes multiple hosts from the map.

Parameters:
Name Type Description
keys Array.<String>
Source:
Fires:
  • HostMap#event:remove

set(key, value)

Adds a new item to the map.

Parameters:
Name Type Description
key String

The key of the host
value Host

The host to be added
Source:
Fires:
  • HostMap#event:remove
  • HostMap#event:add

values() → {Array.<Host>}

Returns a shallow copy of the values of the map.

Source:
Returns:
Type
Array.<Host>