Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

@refarm.dev/storage-memory

This is a formal in-memory implementation of the StorageProvider (storage:v1) contract. It serves as both a reference implementation for plugin developers and a volatile storage primitive for testing and ephemeral sessions.

Role

It implements @refarm.dev/storage-contract-v1 and provides a zero-latency, transient storage engine for host tests, demos, and short-lived sessions.

Features

  • Volatile: Data is lost when the process terminates.
  • Fast: Zero-latency in-memory operations.
  • Conforming: Passes the official storage:v1 conformance suite.

Getting Started

1. Installation

npm install @refarm.dev/storage-memory

2. Usage

import { MemoryStorage } from "@refarm.dev/storage-memory";

const storage = new MemoryStorage();
await storage.put({ id: "note:1", type: "Note", data: { content: "Hello Memory!" } });

3. Build

npm run build

4. Running Conformance Tests

This package is validated against the official storage:v1 contract.

import { runStorageV1Conformance } from "@refarm.dev/storage-contract-v1";
import { MemoryStorage } from "@refarm.dev/storage-memory";

const provider = new MemoryStorage();
const result = await runStorageV1Conformance(provider);
console.log(result.pass ? "conforms" : "failed");

License

MIT