Interface 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 {
    length: number;
    clear(): void;
    getItem(key): null | string;
    key(index): null | string;
    removeItem(key): void;
    setItem(key, value): void;
    [name: string]: any;
}

Indexable

[name: string]: any

Properties

length

Methods

clear getItem key removeItem setItem

Properties

Readonly length

length: number

Returns the number of key/value pairs.

Methods

clear

  • clear(): void

  • Removes all key/value pairs, if there are any.

    Dispatches a storage event on Window objects holding an equivalent Storage object.

    Returns void

getItem

  • getItem(key): null | string

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

    Parameters

    • key: string

    Returns null | string

key

  • key(index): null | string

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

    Parameters

    • index: number

    Returns null | string

removeItem

  • removeItem(key): void

  • Removes the key/value pair with the given key, if a key/value pair with the given key exists.

    Dispatches a storage event on Window objects holding an equivalent Storage object.

    Parameters

    • key: string

    Returns void

setItem

  • setItem(key, value): void

  • 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.)

    Dispatches a storage event on Window objects holding an equivalent Storage object.

    Parameters

    • key: string
    • value: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc