The type used by the Window.localStorage and Window.sessionStorage properties. Storage is implemented as a Map<String, String>.

To store and get values, use Dart's built-in map syntax:

window.localStorage['key1'] = 'val1';
window.localStorage['key2'] = 'val2';
window.localStorage['key3'] = 'val3';
assert(window.localStorage['key3'] == 'val3');

You can use Map APIs such as containsValue(), clear(), and length:

assert(window.localStorage.containsValue('does not exist') == false);
window.localStorage.clear();
assert(window.localStorage.length == 0);

For more examples of using this API, see localstorage_test.dart. For details on using the Map API, see the Maps section of the library tour.

Implements
Annotations
  • DomName('Storage')
  • Unstable()

Properties

isEmpty bool
read-only

isNotEmpty bool
read-only

keys Iterable<String>
read-only

length int
read-only

values Iterable<String>
read-only

Operators

operator [](String key) → String

Returns the value for the given key or null if key is not in the map.

operator []=(String key, String value) → void

Associates the key with the given value.

Methods

addAll(Map<String,String> other) → void

Adds all key-value pairs of other to this map.

clear() → void

Removes all pairs from the map.

containsKey(String key) → bool

Returns true if this map contains the given key.

containsValue(String value) → bool

Returns true if this map contains the given value.

forEach(void f(String key, String value)) → void

Applies f to each key-value pair of the map.

putIfAbsent(String key, String ifAbsent()) → String

Look up the value of key, or add a new value if it isn't there.

remove(String key) → String

Removes key and its associated value, if present, from the map.