@serebano/capacitor-plugin-icloud-kv v0.0.6

@serebano/capacitor-plugin-icloud-kv

Capacitor 7 plugin for syncing simple key‑value preferences across iCloud on iOS.

Install

npm install @serebano/capacitor-plugin-icloud-kv
npx cap sync

⚙️ iOS Setup

Enable iCloud + Key-Value Storage in Xcode:

1. Open ios/App.xcworkspace.
2. Select your app target → Signing & Capabilities.
3. Add iCloud capability and check Key‑Value Storage.

📦 Usage

import { ICloudKV } from '@serebano/capacitor-plugin-icloud-kv';

ICloudKV.addListener('icloudKVDidChange', data => {
  console.log('Synced keys:', data.keys, 'reason:', data.reason);
});

await ICloudKV.set({ key: 'theme', value: 'dark' });
const result = await ICloudKV.get({ key: 'theme' });
console.log('Theme:', result.value);

API

• echo(...)
• set(...)
• get(...)
• addListener('icloudKVDidChange', ...)
• Interfaces
• Type Aliases
• Enums

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

Returns: Promise<{ value: string; }>

set(...)

set(options: { key: string; value: ICloudKVValue; }) => Promise<void>

get(...)

get(options: { key: string; }) => Promise<{ value?: ICloudKVValue; }>

Returns: Promise<{ value?: ICloudKVValue; }>

addListener('icloudKVDidChange', ...)

addListener(eventName: 'icloudKVDidChange', listenerFunc: (data: { reason: ICloudKVSyncReason; keys: string[]; }) => void) => Promise<PluginListenerHandle>

Returns: Promise<PluginListenerHandle>

Interfaces

Date

Enables basic storage and retrieval of dates and times.

PluginListenerHandle

Type Aliases

ICloudKVValue

Supported data types for iCloud Key-Value storage These correspond to the types supported by NSUbiquitousKeyValueStore

string | number | boolean | Date | ICloudKVValue[] | { key: string: ICloudKVValue }

Enums

ICloudKVSyncReason