StorageInstance

StorageInstance<T> = object

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

The storage instance returned by defineStorage, providing upload, serve, and URL methods.

All methods are scoped to the declared schema — TypeScript enforces that file type names and input types match the schema definition.

Example

const storage = defineStorage({ avatars: filetype({ ... }) });

// Upload
const result = await storage.handle("avatars", request, { env, user });

// Serve
const response = await storage.serve("avatars", result.key, { env });

// Client config for StorageProvider
const config = storage.clientConfig();

Type Parameters

T

T extends StorageSchema

The storage schema type mapping file type names to their configs.

Properties

clientConfig()

clientConfig: () => ClientStorageConfig

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

Extract the client-safe subset of the schema for use with StorageProvider.

Returns

ClientStorageConfig

---

getPublicUrl()

getPublicUrl: (name, key) => string

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

Build a public URL for a file in a public bucket.

Parameters

name

keyof T & string

key

string

Returns

string

---

getSignedUrl()

getSignedUrl: (name, key, options) => Promise<string>

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

Generate a time-limited HMAC-signed URL for private file access.

Parameters

name

keyof T & string

key

string

options

SignedUrlOptions

Returns

Promise<string>

---

handle()

handle: <K>(name, request, ctx) => Promise<UploadResult>

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

Parse, validate, and upload a file from an incoming request to R2.

Type Parameters

K

K extends keyof T & string

Parameters

name

K

request

Request

ctx

HandleContext<T[K] extends FiletypeConfig<infer I> ? I : Record<string, unknown>>

Returns

Promise<UploadResult>

---

schema

schema: T

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

The raw schema passed to defineStorage.

---

serve()

serve: (name, key, options) => Promise<Response>

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

Stream a file directly from R2, returning a Response with appropriate headers.

Parameters

name

keyof T & string

key

string

options

ServeOptions

Returns

Promise<Response>

---

verifySignedUrl()

verifySignedUrl: (url, options) => Promise<boolean>

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

Verify that a signed URL has a valid signature and has not expired.

Parameters

url

string

options

env

Record<string, unknown>

Returns

Promise<boolean>