#Alepha - Api Files

#Installation

Part of the alepha package. Import from alepha/api/files.

npm install alepha

#Overview

File storage with metadata: the $storage primitive plus the endpoints, querying and retention that a database makes possible.

Declare a place to keep files with $storage. Every upload writes a files row next to the blob, which is what powers paginated listing, TTL expiry, tags, checksums and creator tracking.

1class Media {2  avatars = $storage({ mimeTypes: ["image/png"], maxSize: 2 });3}4 5const stored = await this.avatars.upload(file, { user });6stored.id; // hand this to GET /api/files/:id

Features:

• $storage primitive with MIME/size constraints and default TTL
• Upload/download HTTP endpoints, ETag-aware
• Paginated, filterable file queries
• TTL-based expiration swept by system.files.purge-deleted
• Storage statistics for the admin UI

Blobs without a database are a FileStorageProvider concern - see alepha/bucket.

#API Reference

#Primitives

• $storage - Declares a named, constrained place to keep files.

#Providers

• DefaultStorage - The default storage.
• FileAccessProvider - Authorization policy for file reads served through FileController.streamFile.
• StorageMultipartCapProvider - Lets the targeted $storage decide how many bytes a request may carry.

#Environment Variables

Environment variables used to configure this module. These can be set in your .env file or through your deployment configuration.