View source

class Storage

package js.html

@:build(s.shortcut.ShortcutMacro.mixinBuild())@:native("Storage")

The Storage interface of the Web Storage API provides access to a particular domain's session or local storage. It allows, for example, the addition, modification, or deletion of stored data items.

Documentation Storage by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Variables

read onlylength:Int

Returns an integer representing the number of data items stored in the Storage object.

Methods

clear():Void

When invoked, will empty all keys out of the storage.

Throws:

null

DOMError

getItem(key:String):String

When passed a key name, will return that key's value.

Throws:

null

DOMError

key(index:Int):String

When passed a number n, this method will return the name of the nth key in the storage.

Throws:

null

DOMError

removeItem(key:String):Void

When passed a key name, will remove that key from the storage.

Throws:

null

DOMError

setItem(key:String, value:String):Void

When passed a key name and value, will add that key to the storage, or update that key's value if it already exists.

Throws:

null

DOMError