@edgefirst-dev/r2-file-storage

An implementation of @mjackson/file-storage that uses R2 as the storage backend.

Features

• Simple, intuitive key/value API (like Web Storage, but for Files instead of strings)
• A generic FileStorage class that works for various Cloudflare R2.
• Preserves all File metadata including file.name, file.type, and file.lastModified

Installation

Install from npm or GitHub Package Registry with;

1bun add @edgefirst-dev/r2-file-storage

Usage

1import { R2FileStorage } from "@edgefirst-dev/r2-file-storage";
2
3let storage = new R2FileStorage(r2); // Get r2 from your Cloudflare bindings
4
5let file = new File(["hello world"], "hello.txt", { type: "text/plain" });
6let key = "hello-key";
7
8// Set the file in storage.
9await storage.set(key, file);
10
11let file = await storage.put(key, file);
12
13// Then, sometime later...
14let fileFromStorage = await storage.get(key);
15// All of the original file's metadata is intact
16fileFromStorage.name; // 'hello.txt'
17fileFromStorage.type; // 'text/plain'
18
19// To remove from storage
20await storage.remove(key);
21
22await storage.list({ prefix: "hello" }); // List all files with keys starting with "hello"

License

See LICENSE

Author

• Sergio Xalambrí