@sigx/lynx-storage

Persistent key-value storage for sigx-lynx. UserDefaults on iOS, SharedPreferences on Android. Same shape as localStorage / AsyncStorage (string keys, string values).

Install

pnpm add @sigx/lynx-storage

sigx prebuild auto-discovers the package via its signalx-module.json and links the native module. No special permissions on either platform.

Usage

import { Storage } from '@sigx/lynx-storage';

Storage.setItem('user', JSON.stringify({ name: 'Alice', id: 42 }));
const raw = await Storage.getItem('user');
const user = raw ? JSON.parse(raw) : null;

Storage.removeItem('user');

const keys = await Storage.getAllKeys();
Storage.clear();   // wipes everything in this app's namespace

API

| Method | Notes | | -------------------------------------------- | -------------------------------------------------------------------------------------------------- | | setItem(key: string, value: string): void | Sync — fire-and-forget write. | | getItem(key: string): Promise<string \| null> | Async. Returns null if the key isn't set. | | removeItem(key: string): void | Sync — no error if the key doesn't exist. | | clear(): void | Wipes the entire app namespace. | | getAllKeys(): Promise<string[]> | Returns all currently-set keys. | | isAvailable(): boolean | Whether the native module is registered in the current build. |

Gotchas

• String values only. Serialize objects with JSON.stringify / JSON.parse yourself. Don't dump raw binary — use @sigx/lynx-file-system for that.
• Sync writes can race with reads if you setItem then immediately getItem the same key from BG. UserDefaults / SharedPreferences both use a write-behind buffer; values are returned correctly within the same process, just be aware of cross-process scenarios (extension apps on iOS, etc.) where eventual consistency applies.
• Persistence semantics. Both stores survive app updates, are excluded from app-data exports on Android, and follow iCloud-backup rules on iOS (UserDefaults is included by default).

Reference app

examples/lynx-one/my-sigx-app/src/cards/StorageCard.tsx covers a write/read round-trip + getAllKeys + clear.