Skip to main content

Storage Port (ports)

Classes​

StoragePort​

import { StoragePort } from '@hexajs-dev/ports';
class StoragePort { ... }

Methods​

clear()

clear(areaName: HexaWebStorageAreaName): Promise<void>

get()

get(areaName: HexaWebStorageAreaName, keys: string | string[] | {
    [key: string]: any;
} | null): Promise<{
    [key: string]: any;
}>

onChangedAddListener()

onChangedAddListener(listener: (changes: HexaWebStorageChangesMap, areaName: HexaWebStorageAreaName) => void): void

onChangedRemoveListener()

onChangedRemoveListener(listener: (changes: HexaWebStorageChangesMap, areaName: HexaWebStorageAreaName) => void): void

remove()

remove(areaName: HexaWebStorageAreaName, keys: string | string[]): Promise<void>

set()

set(areaName: HexaWebStorageAreaName, items: SetItems): Promise<void>

setAccessLevel()

setAccessLevel(options: HexaWebStorageSetAccessLevelOptions): Promise<void>

Supporting Types​

SetItems​

interface SetItems {
  [key: string]: any;
}