file-storage

file-storage is a key/value interface for storing File objects in JavaScript.

Handling file uploads and storage is a common requirement in web applications, but each storage backend (local disk, AWS S3, Cloudflare R2, etc.) has its own API and conventions. This fragmentation makes it difficult to write portable code that can easily switch between storage providers or support multiple backends simultaneously.

Similar to how localStorage allows you to store key/value pairs of strings in the browser, file-storage allows you to store key/value pairs of files on the server with a consistent interface regardless of the underlying storage mechanism.

Features

• Simple API - Intuitive key/value API (like Web Storage, but for Files instead of strings)
• Generic Interface - FileStorage interface that works for various large object storage backends (can be adapted to AWS S3, Cloudflare R2, etc.)
• Streaming Support - Stream file content to and from storage
• Metadata Preservation - Preserves all File metadata including file.name, file.type, and file.lastModified

Installation

Install from npm:

npm install @remix-run/file-storage

Usage

File System

import { createFsFileStorage } from '@remix-run/file-storage/fs'

let storage = createFsFileStorage('./user/files')

let file = new File(['hello world'], 'hello.txt', { type: 'text/plain' })
let key = 'hello-key'

// Put the file in storage.
await storage.set(key, file)

// Then, sometime later...
let fileFromStorage = await storage.get(key)
// All of the original file's metadata is intact
fileFromStorage.name // 'hello.txt'
fileFromStorage.type // 'text/plain'

// To remove from storage
await storage.remove(key)

Related Packages

• form-data-parser - Pairs well with this library for storing FileUpload objects received in multipart/form-data requests
• lazy-file - The streaming File implementation used internally to stream files from storage

License

See LICENSE