Key System

File keys

Every file has a plain string fileKey. Use readable slash-delimited values that reflect your domain model:

const fileKey = "users/42/avatar";

Validation rules:

• fileKey must be non-empty.
• Path segments are / delimited.
• Empty segments are rejected.
• . and .. segments are rejected.
• Control characters are rejected.

Prefix queries

List files with a shared prefix:

const { useFiles } = uploadClient;

const { data } = useFiles({
  query: {
    provider: "r2-binding",
    prefix: "users/42/",
  },
});