CupThread React Native & Expo SDK - v0.1.0
    Preparing search index...

    Interface TokenStorageAdapter

    Interface for pluggable key-value persistence adapters used by UserTokenStore.

    Compatible with AsyncStorage, expo-secure-store, MMKV, localStorage, or in-memory dictionaries.

    Storage security: The configured adapter persists the bearer identity token used to attribute all SDK actions (votes, comments, feedback, user attributes). Plaintext adapters like AsyncStorage are suitable for local development or anonymous-only identifiers, but production applications—particularly those calling UserTokenStore.setToken with real user IDs—should configure an encrypted-at-rest adapter (such as expo-secure-store in Expo or react-native-keychain / encrypted MMKV in bare React Native) to prevent token exposure via device backups or rooted device storage.

    Plaintext adapter (development / anonymous-only):

    import AsyncStorage from '@react-native-async-storage/async-storage';
    import { TokenStorageAdapter, UserTokenStore } from '@cupthread/react-native';

    const adapter: TokenStorageAdapter = {
      getItem: (key) => AsyncStorage.getItem(key),
      setItem: (key, val) => AsyncStorage.setItem(key, val),
      removeItem: (key) => AsyncStorage.removeItem(key),
    };

    UserTokenStore.configure(adapter);

    Encrypted adapter using expo-secure-store (recommended for production & authenticated users):

    import * as SecureStore from 'expo-secure-store';
    import { TokenStorageAdapter, UserTokenStore } from '@cupthread/react-native';

    const secureAdapter: TokenStorageAdapter = {
      getItem: (key) => SecureStore.getItemAsync(key),
      setItem: (key, value) => SecureStore.setItemAsync(key, value),
      removeItem: (key) => SecureStore.deleteItemAsync(key),
    };

    UserTokenStore.configure(secureAdapter);
    interface TokenStorageAdapter {
        getItem(key: string): string | Promise<string | null> | null;
        removeItem?(key: string): void | Promise<void>;
        setItem(key: string, value: string): void | Promise<void>;
    }
    Index
    getItem removeItem? setItem

    • Retrieves the stored string value for the given storage key.

      Parameters

      • key: string

        The unique storage identifier.

      Returns string | Promise<string | null> | null

      Stored string value, null if not found, or a Promise resolving to it.

    • Optional cleanup handler to remove an entry from storage.

      Parameters

      • key: string

        The unique storage identifier to delete.

      Returns void | Promise<void>

    • Persists a key-value pair into storage.

      Parameters

      • key: string

        The unique storage identifier.

      • value: string

        The string payload to persist.

      Returns void | Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods