Constructor
new 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.
Extends
- events.EventEmitter
Methods
forEach(callback)
Executes a provided function once per map element.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
get(key) → {Host}
Gets a host by key or undefined if not found.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
String |
Returns:
- Type
- Host
keys() → {Array.<String>}
Returns an array of host addresses.
Returns:
- Type
- Array.<String>
remove(key)
Removes an item from the map.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
String | The key of the host |
Fires:
removeMultiple(keys)
Removes multiple hosts from the map.
Parameters:
| Name | Type | Description |
|---|---|---|
keys |
Array.<String> |
Fires:
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 |
Fires:
values() → {Array.<Host>}
Returns a shallow copy of the values of the map.
Returns:
- Type
- Array.<Host>
Events
add
Emitted when a host is added to the map
remove
Emitted when a host is removed from the map