FiletypeConfig

FiletypeConfig<TInput> = object

Defined in: packages/storage/src/types.ts:136

Configuration for a single file type within a storage schema.

Defines the R2 bucket, accepted MIME types, size limits, key generation strategy, and optional lifecycle hooks for a category of files.

Example

import { filetype } from "@cfast/storage";

const avatars = filetype({
  bucket: "UPLOADS",
  accept: ["image/jpeg", "image/png", "image/webp"],
  maxSize: "2mb",
  key: (file, ctx) => `avatars/${ctx.user.id}/${file.name}`,
  replace: true,
});

Type Parameters

TInput

TInput = Record<string, unknown>

The shape of caller-provided input available in the key function and hooks.

Properties

accept

accept: readonly string[]

Defined in: packages/storage/src/types.ts:140

MIME types accepted for this file type (e.g. ["image/jpeg", "image/png"]).

bucket

bucket: string

Defined in: packages/storage/src/types.ts:138

R2 binding name from the Workers environment (e.g. "UPLOADS").

hooks?

optional hooks: FiletypeHooks<TInput>

Defined in: packages/storage/src/types.ts:156

Lifecycle hooks that run before and after upload.

key()

key: (file, ctx) => string

Defined in: packages/storage/src/types.ts:144

Function that generates the R2 object key for an uploaded file.

Parameters

file

extension

string

name

string

ctx

KeyContext<TInput>

Returns

string

maxSize

maxSize: string

Defined in: packages/storage/src/types.ts:142

Maximum file size as a human-readable string (e.g. "10mb", "500kb").

mimeGroups?

optional mimeGroups: readonly NormalizedMimeGroup[]

Defined in: packages/storage/src/types.ts:164

Optional per-mime-group size limits. When set, each mime group’s maxSize is enforced independently — a file whose mime type belongs to a given group must fit within that group’s limit.

Populated automatically when using the per-mime form of filetype.