Class R2Service<E>

Object-storage capability, backed by R2.

Author

Bayu Dwiyan Satria

Version

1.0.0

Since

1.0.0

Type Parameters

E extends CloudflareEnv = CloudflareEnv

Implements

ObjectStore<E>

Index

Constructors

constructor

Methods

download downloadJson exists isAvailable list remove upload uploadJson

Constructors

constructor

new R2Service<E extends CloudflareEnv = CloudflareEnv>(): R2Service<E>
Type Parameters
- E extends CloudflareEnv = CloudflareEnv
Returns R2Service<E>

Methods

download

download(env: E, key: string): Promise<string>
Reads an object as text.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
Returns Promise<string>
The body, or null when the object does not exist.
Implementation of ObjectStore.download
- Defined in src/core/services/R2Service.ts:69

downloadJson

downloadJson<T = unknown>(env: E, key: string): Promise<T>
Reads an object and parses it as JSON.
Type Parameters
- T = unknown
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
Returns Promise<T>
The parsed body, or null when the object does not exist.
Implementation of ObjectStore.downloadJson
- Defined in src/core/services/R2Service.ts:80

exists

exists(env: E, key: string): Promise<boolean>
Checks whether an object exists.

Reads metadata only, so no body is transferred.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
Returns Promise<boolean>
true when the object exists.
Implementation of ObjectStore.exists
- Defined in src/core/services/R2Service.ts:93

isAvailable

isAvailable(env: E): boolean
Reports whether the bucket is bound to this Worker.
Parameters
- env: E
  The Worker environment.
Returns boolean
true when the binding is present.
Implementation of ObjectStore.isAvailable
- Defined in src/core/services/R2Service.ts:132

list

list(env: E, prefix: string): Promise<StoredObject[]>
Lists the objects under a prefix.
Parameters
- env: E
  The Worker environment.
- prefix: string
  The key prefix to match.
Returns Promise<StoredObject[]>
The matched objects.

Remarks
One page only — R2 paginates, and a full walk is rarely what a request handler wants.
Implementation of ObjectStore.list
- Defined in src/core/services/R2Service.ts:120

remove

remove(env: E, keys: string | string[]): Promise<void>
Deletes one or more objects.

Deleting a key that does not exist is not an error.
Parameters
- env: E
  The Worker environment.
- keys: string | string[]
  A key, or a list of keys.
Returns Promise<void>
Implementation of ObjectStore.remove
- Defined in src/core/services/R2Service.ts:105

upload

upload(
    env: E,
    key: string,
    body: string | ReadableStream<any> | ArrayBuffer | ArrayBufferView | Blob,
    contentType?: string,
): Promise<StoredObject>
Stores an object.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
- body: string | ReadableStream<any> | ArrayBuffer | ArrayBufferView | Blob
  The object body.
- contentType: string = 'application/octet-stream'
  MIME type recorded on the object.
Returns Promise<StoredObject>
The stored object's key and size.
Implementation of ObjectStore.upload
- Defined in src/core/services/R2Service.ts:37

uploadJson

uploadJson(env: E, key: string, value: unknown): Promise<StoredObject>
Stores a value as JSON.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
- value: unknown
  The value to serialise.
Returns Promise<StoredObject>
The stored object's key and size.
Implementation of ObjectStore.uploadJson
- Defined in src/core/services/R2Service.ts:56

Class R2Service<E>

Author

Version

Since

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns R2Service<E>

Methods

download

Parameters

Returns Promise<string>

downloadJson

Type Parameters

Parameters

Returns Promise<T>

exists

Parameters

Returns Promise<boolean>

isAvailable

Parameters

Returns boolean

list

Parameters

Returns Promise<StoredObject[]>

Remarks

remove

Parameters

Returns Promise<void>

upload

Parameters

Returns Promise<StoredObject>

uploadJson

Parameters

Returns Promise<StoredObject>

Settings

On This Page