Variable cstorage`Const`

cstorage: {
    local: {
        get(keys?: StorageAreaKeys): Promise<{ [key: string]: any }>;
        set(items: Record<string, unknown>): Promise<void>;
        remove(keys: string | string[]): Promise<void>;
        clear(): Promise<void>;
    };
    session: {
        get(keys?: StorageAreaKeys): Promise<{ [key: string]: any }>;
        set(items: Record<string, unknown>): Promise<void>;
        remove(keys: string | string[]): Promise<void>;
        clear(): Promise<void>;
    };
    onChanged: {
        addListener(listener: ChangedListener): void;
        removeListener(listener: ChangedListener): void;
    };
} = ...

Compression-aware wrapper around chrome.storage. Use exactly like chrome.storage.local / chrome.storage.session, but values are transparently LZ-compressed at rest.

Type declaration

local: {
    get(keys?: StorageAreaKeys): Promise<{ [key: string]: any }>;
    set(items: Record<string, unknown>): Promise<void>;
    remove(keys: string | string[]): Promise<void>;
    clear(): Promise<void>;
}
session: {
    get(keys?: StorageAreaKeys): Promise<{ [key: string]: any }>;
    set(items: Record<string, unknown>): Promise<void>;
    remove(keys: string | string[]): Promise<void>;
    clear(): Promise<void>;
}
onChanged: {
addListener(listener: ChangedListener): void;
removeListener(listener: ChangedListener): void;
}
- addListener: function
  - addListener(listener: ChangedListener): void
    Registers a listener that receives change events with oldValue / newValue already decompressed.
    Parameters
    listener: ChangedListener
    Returns void
    Defined in src/utils/storage.ts:224
- removeListener: function
  - removeListener(listener: ChangedListener): void
    Removes a listener previously added via addListener.
    Parameters
    listener: ChangedListener
    Returns void
    Defined in src/utils/storage.ts:232

Example

await cstorage.local.set({ USER_SETTINGS: settings });
const { USER_SETTINGS } = await cstorage.local.get<{ USER_SETTINGS: UserSettings }>("USER_SETTINGS");