Class FS

Upload, store and serve images, videos, music, documents and other unstructured data in your Edge-first application.

Hierarchy

R2FileStorage
- FS

Index

Constructors

Properties

Accessors

Methods

get has keys remove serve set uploadHandler

Constructors

constructor

new FS(r2: R2Bucket): FS
Parameters
- r2: R2Bucket
  The R2Bucket bindings to use
Returns FS
Inherited from R2FileStorage.constructor
- Defined in node_modules/@edgefirst-dev/r2-file-storage/build/lib/r2-file-storage.d.ts:17

Properties

`Protected`r2

r2: R2Bucket

Accessors

binding

get binding(): R2Bucket
Returns R2Bucket
- Defined in src/lib/fs/fs.ts:54

Methods

get

get(key: string): Promise<null | File>
Returns the file with the given key, or null if no such key exists.
Parameters
- key: string
Returns Promise<null | File>
Inherited from R2FileStorage.get
- Defined in node_modules/@edgefirst-dev/r2-file-storage/build/lib/r2-file-storage.d.ts:20

has

has(key: string): Promise<boolean>
Returns true if a file with the given key exists, false otherwise.
Parameters
- key: string
Returns Promise<boolean>
Inherited from R2FileStorage.has
- Defined in node_modules/@edgefirst-dev/r2-file-storage/build/lib/r2-file-storage.d.ts:18

keys

keys(options?: FS.Keys.Options): Promise<FS.Keys.Result>
Returns a list of all keys in storage.
Parameters
- options: FS.Keys.Options = {}
Returns Promise<FS.Keys.Result>
- Defined in src/lib/fs/fs.ts:61

remove

remove(key: string): Promise<void>
Removes the file with the given key from storage.
Parameters
- key: string
Returns Promise<void>
Inherited from R2FileStorage.remove
- Defined in node_modules/@edgefirst-dev/r2-file-storage/build/lib/r2-file-storage.d.ts:21

serve

serve(key: string, init?: Init): Promise<Response>
Returns a Response with the file body and correct headers. If the file doesn't exits it returns a 404 response with an empty body.
Parameters
- key: string
  The key of the file to serve
- init: Init = {}
  The response init object, with an optional fallback body
Returns Promise<Response>
- Defined in src/lib/fs/fs.ts:74

set

set(key: string, file: File): Promise<void>
Puts a file in storage at the given key.
Parameters
- key: string
- file: File
Returns Promise<void>
Inherited from R2FileStorage.set
- Defined in node_modules/@edgefirst-dev/r2-file-storage/build/lib/r2-file-storage.d.ts:19

uploadHandler

uploadHandler(
allowedFieldNames: AllowedFieldNames,
getKey?: GetKeyFunction,
): FileUploadHandler
Create a new FileUploadHandler function that will automatically upload files to the File Storage.

The handle will only upload files if they match a list of valid input field name. The key used to store the file can be customized with a getKey function.
Parameters
- allowedFieldNames: AllowedFieldNames
  The form field names allowed to upload files.
- OptionalgetKey: GetKeyFunction
  A function that returns the key usd to store the file in the file system.
Returns FileUploadHandler
A file upload handler function that can be used with the parseFormData.
- Defined in src/lib/fs/fs.ts:106