Vaultrice SDK - v1.1.1
    Preparing search index...

    Interface StorageAdapter

    Interface for pluggable storage adapters.

    Implement this interface to provide custom storage backends for offline sync. Adapters must serialize the value object when storing, and deserialize it when retrieving. The value passed to set(key, value) is an object matching the ItemType shape: { value, expiresAt, createdAt, updatedAt, keyVersion? }

    class MyAdapter implements StorageAdapter {
      constructor(options: { projectId: string; class: string; id: string; ttl: number }) { ... }
      async set(key: string, value: any): Promise<void> {
        // Serialize value before storing
        localStorage.setItem(key, JSON.stringify(value))
      }
      async get(key: string): Promise<any | null> {
        // Deserialize value when retrieving
        const raw = localStorage.getItem(key)
        return raw ? JSON.parse(raw) : null
      }
      ...
    }
    interface StorageAdapter {
        get(key: string): Promise<any>;
        set(key: string, value: any): Promise<void>;
        remove(key: string): Promise<void>;
        getAll(): Promise<Record<string, any>>;
    }
    Index

    Methods

    get set remove getAll

    Methods

    • Retrieve a value by key.

      Parameters

      • key: string

        The key to look up.

      Returns Promise<any>

      The value, or null if not found.

    • Store a value by key.

      Parameters

      • key: string

        The key to store under.

      • value: any

        The value to store.

      Returns Promise<void>

    • Remove a value by key.

      Parameters

      • key: string

        The key to remove.

      Returns Promise<void>

    • Retrieve all key-value pairs.

      Returns Promise<Record<string, any>>

      An object mapping keys to values.

    Settings

    Member Visibility

    On This Page

    Methods