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.

    MDN Reference

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

    Indexable

    • [name: string]: any

    Properties

    length: number

    Returns the number of key/value pairs.

    MDN Reference

    Methods

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

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

      MDN Reference

      Returns void

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

      MDN Reference

      Parameters

      • key: string

      Returns string

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

      MDN Reference

      Parameters

      • index: number

      Returns string

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

      MDN Reference

      Parameters

      • key: string

      Returns 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.

      MDN Reference

      Parameters

      • key: string
      • value: string

      Returns void