@tevm/sync-storage-persister/src/Storage.ts

A package for persisting the state of the EVM to a sync storage

/**
 * Interface for storage providers that can be used with sync-storage-persister
 * Provides a minimal subset of the Web Storage API (localStorage/sessionStorage)
 * for storing and retrieving data.
 *
 * @example
 * ```typescript
 * import { Storage } from '@tevm/sync-storage-persister'
 *
 * // Implement the Storage interface with localStorage
 * const webStorage: Storage = {
 *   getItem: (key) => localStorage.getItem(key),
 *   setItem: (key, value) => localStorage.setItem(key, value),
 *   removeItem: (key) => localStorage.removeItem(key)
 * }
 *
 * // Or create a custom in-memory implementation
 * const memoryStorage: Storage = {
 *   store: new Map<string, string>(),
 *   getItem: (key) => this.store.get(key) || null,
 *   setItem: (key, value) => this.store.set(key, value),
 *   removeItem: (key) => this.store.delete(key)
 * }
 * ```
 */
export interface Storage {
	getItem: (key: string) => string | null
	setItem: (key: string, value: string) => void
	removeItem: (key: string) => void
}