Storage class

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);
Mixed in types
Annotations
  • @Unstable()
  • @Native("Storage")

Properties

entriesIterable<MapEntry<String, String>>
read-only, inherited
The map entries of this.
hashCodeint
read-only, inherited
The hash code for this object. [...]
isEmptybool
read-only, override
Whether there is no key/value pair in the map.
isNotEmptybool
read-only, override
Whether there is at least one key/value pair in the map.
keysIterable<String>
read-only, override
The keys of this. [...]
lengthint
read-only, override
The number of key/value pairs in the map.
runtimeTypeType
read-only, inherited
A representation of the runtime type of the object.
valuesIterable<String>
read-only, override
The values of this. [...]

Methods

addAll(Map<String, String> other) → void
override
Adds all key/value pairs of other to this map. [...]
addEntries(Iterable<MapEntry<String, String>> newEntries) → void
inherited
Adds all key/value pairs of newEntries to this map. [...]
cast<RK, RV>() → Map<RK, RV>
inherited
Provides a view of this map as having RK keys and RV instances, if necessary. [...]
clear() → void
override
Removes all entries from the map. [...]
containsKey(Object? key) → bool
override
Whether this map contains the given key. [...]
containsValue(Object? value) → bool
override
Whether this map contains the given value. [...]
forEach(void f(String key, String value)) → void
override
Applies action to each key/value pair of the map. [...]
map<K2, V2>(MapEntry<K2, V2> transform(String key, String value)) → Map<K2, V2>
inherited
Returns a new map where all entries of this map are transformed by the given convert function.
noSuchMethod(Invocation invocation) → dynamic
inherited
Invoked when a non-existent method or property is accessed. [...]
putIfAbsent(String key, String ifAbsent()) → String
override
Look up the value of key, or add a new entry if it isn't there. [...]
remove(Object? key) → String?
override
Removes key and its associated value, if present, from the map. [...]
removeWhere(bool test(String key, String value)) → void
inherited
Removes all entries of this map that satisfy the given test.
toString() → String
inherited
A string representation of this object. [...]
update(String key, String update(String value), {String ifAbsent()}) → String
inherited
Updates the value for the provided key. [...]
updateAll(String update(String key, String value)) → void
inherited
Updates all values. [...]

Operators

operator ==(Object other) → bool
inherited
The equality operator. [...]
operator [](Object? key) → String?
override
The value for the given key, or null if key is not in the map. [...]
operator []=(String key, String value) → void
override
Associates the key with the given value. [...]

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dart.dev/stable/2.13.0/dart-html/Storage-class.html