API Documentation for: 0.11.8
Show:

window.Map Class

Defined in: window.Map:4
Module: platypus

Available since 0.8.0

This class defines a limited polyfill for Map. If the browser supports Map, this class is not used.

Item Index

Methods

Properties

Methods

delete

(
  • key
)
Any

Defined in delete:79

Deletes a key (and value) from the Map.

Parameters:

  • key String

    The key to delete from the Map.

Returns:

Any:

value The value of the key is returned.

get

(
  • key
)
Any

Defined in get:38

Returns the value of the provided key.

Parameters:

  • key String

    The key to lookup.

Returns:

Any:

value The value of the provded key.

has

(
  • key
)
Boolean

Defined in has:51

Determines whether the provided key is available in this Map.

Parameters:

  • key String

    The key to lookup.

Returns:

Boolean:

value Whether the key is listed in this Map.

set

(
  • key
  • value
)
chainable

Defined in set:64

Sets a value to a key in the Map.

Parameters:

  • key String

    The key to associate with the provided value.

  • value Any

    The value to be stored by the Map.

Properties

map

Object private

Defined in map:23

This is an object containing a list of key/value pairs. This property should not be used directly.

Default: {}