Storage

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

interface Storage {
[name: string]: any;
readonly length: number;
clear(): void;
getItem(key: string): string | null;
key(index: number): string | null;
removeItem(key: string): void;
setItem(key: string, value: string): void;
}
var Storage: {
prototype: Storage;
new (): Storage;
}
;

§Index Signatures

§
[name: string]: any

§Properties

§
readonly length: number
[src]

Returns the number of key/value pairs currently present in the list associated with the object.

§Methods

§
clear(): void
[src]

Empties the list associated with the object of all key/value pairs, if there are any.

§
getItem(key: string): string | null
[src]

Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.

§
key(index: number): string | null
[src]

Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.

§
removeItem(key: string): void
[src]

Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.

§
setItem(key: string, value: string): void
[src]

Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.

Throws a "QuotaExceededError" DOMException exception if the new value couldn't be set. (Setting could fail if, e.g., the user has disabled storage for the site, or if the quota has been exceeded.)