Skip to content

@drupal-js-sdk/storage

Overview

Simple storage adapters for in-memory and Web Storage use cases. Useful for persisting session/config data across requests.

Usage

JavaScript
import { StorageInMemory, StorageInWeb } from "@drupal-js-sdk/storage";

const mem = new StorageInMemory();
mem.setItem("token", { value: "abc" });

const web = new StorageInWeb(() => window.localStorage);
web.setString("app", "docs");

Public API

class StorageInMemory

Constructor

constructor();

getString

getString(keyName: string): string | null

setString

setString(keyName: string, keyValue: string): void

isAvailable

isAvailable(): boolean

getItem

getItem(keyName: string): StorageValueType

setItem

setItem(keyName: string, keyValue: StorageValueType): void

removeItem

removeItem(keyName: string): void

clear

clear(): void

get

get(): StorageRecordInterface

set

set(data: StorageRecordInterface): void

class StorageInWeb

Constructor

constructor(getStorage?: () => Storage)

getString

getString(keyName: string): string | null

setString

setString(keyName: string, keyValue: string): void

isAvailable

isAvailable(): boolean

getItem

getItem(keyName: string): StorageValueType

setItem

setItem(keyName: string, keyValue: StorageValueType): void

removeItem

removeItem(keyName: string): void

clear

clear(): void

get

get(): StorageRecordInterface

set

set(data: StorageRecordInterface): void

Notes

  • Implements StorageInterface from @drupal-js-sdk/interfaces.