Class ChromeStorage

Internalapi

A storage that can be used in chrome extensions

Hierarchy

  • ChromeStorage

Implements

Constructors

constructor

Methods

delete get getPrefixedKey set subscribeToStorageChanged isSupported

Constructors

constructor

Methods

delete

  • Delete a key from storage

    Type Parameters

    Parameters

    • key: K

      The storage key

    Returns Promise<void>

get

getPrefixedKey

  • Get the key with the internal prefix

    Parameters

    • key: string

      the storage key

    Returns string

set

  • Sets a value in the storage and persist it

    Type Parameters

    Parameters

    Returns Promise<void>

subscribeToStorageChanged

  • This event will fire if the storage was modified by someone else, eg. on another tab

    Parameters

    • _callback: ((arg) => {})

      The callback to be called when a storage value changes

        • (arg): {}

        • Parameters

          • arg: {
                eventType: "storageCleared" | "entryModified";
                key: null | string;
                newValue: null | string;
                oldValue: null | string;
            }
            • eventType: "storageCleared" | "entryModified"
            • key: null | string
            • newValue: null | string
            • oldValue: null | string

          Returns {}

      Returns Promise<void>

    Static isSupported

    • Returns a promise that resolves to true if the storage option is available on this platform.

      Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc