@alessiofrittoli/web-utils/dist/storage/LocalStorage.d.mts

Common TypeScript web utilities

/**
 * A browser-compatible implementation of [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). Data is stored
 * unencrypted in the file specified by the `--localstorage-file` CLI flag.
 * The maximum amount of data that can be stored is 10 MB.
 * Any modification of this data outside of the Web Storage API is not supported.
 * Enable this API with the `--experimental-webstorage` CLI flag.
 * `localStorage` data is not stored per user or per request when used in the context
 * of a server, it is shared across all users and requests.
 */
declare class LocalStorage {
    /**
     * Get the current value associated with the given `key`, or `undefined` if the given `key` does not exist.
     *
     * @param	key The item name.
     * @returns	The current value associated with the given `key`, or `undefined` if the given `key` does not exist.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/getItem)
     */
    static get<T>(key: string): T | undefined;
    /**
     * 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.
     *
     * @param	key		The item name.
     * @param	value	The item value.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/setItem)
     */
    static set<T>(key: string, value: T): 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.
     *
     * @param key The item name.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/removeItem)
     */
    static delete(key: string): void;
    /**
     * Removes all key/value pairs, if there are any.
     *
     * Dispatches a storage event on Window objects holding an equivalent Storage object.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/clear)
     */
    static clear(): void;
    /**
     * Get storage item name by item numeric index.
     *
     * @param	index The item index in the storage.
     * @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](https://developer.mozilla.org/docs/Web/API/Storage/key)
     */
    static key(index: number): string | null;
    /**
     * Get the number of key/value pairs.
     *
     * @returns	The number of key/value pairs.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Storage/length)
     */
    static getLength(): number;
}

export { LocalStorage };