Interface StorageHelper

Storage Helper

Use application to prefix data stored in browser storage with helpers for compatibility.

interface StorageHelper {
    clear(full: boolean): void;
    getItem(key: string, both?: boolean): null | string;
    prefixedKey(key: string): string;
    removeItem(key: string, both?: boolean): void;
    setItem(key: string, value: string, both?: boolean): void;
}

Methods

clear getItem prefixedKey removeItem setItem

Methods

clear

  • clear(full: boolean): void

  • Remove all items from window storage starting with application prefix

    Parameters

    • full: boolean

      remove unprefixed keys as well

    Returns void

getItem

  • getItem(key: string, both?: boolean): null | string

  • Get value from window storage with prefixed key

    Parameters

    • key: string

      storage lookup key

    • Optional both: boolean

      get with unprefixed key if not found

    Returns null | string

prefixedKey

  • prefixedKey(key: string): string

  • Prefix key with application name, i.e. cockpit.transport.application() + ':' + key;

    Parameters

    • key: string

      storage lookup key

    Returns string

removeItem

  • removeItem(key: string, both?: boolean): void

  • Remove a value from window storage with prefixed key

    Parameters

    • key: string

      storage lookup key

    • Optional both: boolean

      remove with both prefixed and unprefixed key

    Returns void

setItem

  • setItem(key: string, value: string, both?: boolean): void

  • Set value from window storage with prefixed key

    Parameters

    • key: string

      storage lookup key

    • value: string

      value to set

    • Optional both: boolean

      set with both prefixed and unprefixed key

    Returns void

Settings

Member Visibility

Theme

On This Page

cleargetItemprefixedKeyremoveItemsetItem