Class R2Binding<E>

Accessor for the R2 bucket binding (r2_buckets in wrangler.json).

Example

const storage = new R2Binding() // binding name from the configuration layer
await storage.put(ctx.env, 'reports/2026-07.csv', body)
const object = await storage.get(ctx.env, 'reports/2026-07.csv')

Author

Bayu Dwiyan Satria

Version

1.0.0

Since

1.0.0

Type Parameters

E extends CloudflareEnv = CloudflareEnv

Hierarchy (View Summary)

Binding<R2Bucket, E>
- R2Binding

Index

Constructors

constructor

new R2Binding<E extends CloudflareEnv = CloudflareEnv>(
settings?: R2Settings,
): R2Binding<E>
Constructs an R2Binding instance.
Type Parameters
- E extends CloudflareEnv = CloudflareEnv
Parameters
- Optionalsettings: R2Settings
  Resolved settings. Defaults to resolve('r2'), so callers normally construct this with no arguments at all.
Returns R2Binding<E>
Overrides Binding.constructor
- Defined in src/core/bindings/R2Binding.ts:29

Accessors

name

get name(): string
The binding name this instance resolves.

Returns string
The binding name as declared in wrangler.json.
Inherited from Binding.name
- Defined in src/core/bindings/Binding.ts:58

Methods

delete

delete(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 single object key, or a list of keys.
Returns Promise<void>
- Defined in src/core/bindings/R2Binding.ts:126

get

get(env: E, key: string, options?: R2GetOptions): Promise<R2ObjectBody>
Reads an object, body included.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
- Optionaloptions: R2GetOptions
  Get options — range and conditional headers.
Returns Promise<R2ObjectBody>
The object, or null when it does not exist.

Throws
MissingBindingError When the R2 binding is absent.
- Defined in src/core/bindings/R2Binding.ts:44

getJson

getJson<T = unknown>(env: E, key: string): Promise<T>
Reads an object's body 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.
- Defined in src/core/bindings/R2Binding.ts:68

getText

getText(env: E, key: string): Promise<string>
Reads an object's body as text.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
Returns Promise<string>
The body as text, or null when the object does not exist.
- Defined in src/core/bindings/R2Binding.ts:55

head

head(env: E, key: string): Promise<R2Object>
Reads an object's metadata without transferring its body.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
Returns Promise<R2Object>
The object metadata, or null when it does not exist.
- Defined in src/core/bindings/R2Binding.ts:81

isBound

isBound(env: E): boolean
Checks whether the binding is available on the given environment.

Use this to degrade gracefully when a binding is optional.
Parameters
- env: E
  The Worker environment.
Returns boolean
true when the binding is present.
Inherited from Binding.isBound
- Defined in src/core/bindings/Binding.ts:74

list

list(env: E, options?: R2ListOptions): Promise<R2Objects>
Lists objects in the bucket.
Parameters
- env: E
  The Worker environment.
- Optionaloptions: R2ListOptions
  List options — prefix, delimiter, limit, and cursor.
Returns Promise<R2Objects>
The matched objects and pagination state.

Remarks
Results are paginated — check truncated and pass the returned cursor back in to read the next page.
- Defined in src/core/bindings/R2Binding.ts:141

put

put(
    env: E,
    key: string,
    value: string | ReadableStream<any> | ArrayBuffer | ArrayBufferView | Blob,
    options?: R2PutOptions,
): Promise<R2Object>
Writes an object.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
- value: string | ReadableStream<any> | ArrayBuffer | ArrayBufferView | Blob
  The object body.
- Optionaloptions: R2PutOptions
  Put options — HTTP metadata, custom metadata, and checksums.
Returns Promise<R2Object>
The stored object's metadata.
- Defined in src/core/bindings/R2Binding.ts:94

putJson

putJson(
    env: E,
    key: string,
    value: unknown,
    options?: R2PutOptions,
): Promise<R2Object>
Serialises a value to JSON and writes it as an object.
Parameters
- env: E
  The Worker environment.
- key: string
  The object key.
- value: unknown
  The value to serialise and store.
- options: R2PutOptions = {}
  Put options. The JSON content type is applied when unset.
Returns Promise<R2Object>
The stored object's metadata.
- Defined in src/core/bindings/R2Binding.ts:112

resolve

resolve(env: E): R2Bucket
Resolves the binding, failing fast when it is not configured.
Parameters
- env: E
  The Worker environment.
Returns R2Bucket
The resolved binding.

Throws
MissingBindingError When the binding is absent from the environment.
Inherited from Binding.resolve
- Defined in src/core/bindings/Binding.ts:85

tryResolve

tryResolve(env: E): R2Bucket
Resolves the binding without throwing.
Parameters
- env: E
  The Worker environment.
Returns R2Bucket
The resolved binding, or null when it is not configured.
Inherited from Binding.tryResolve
- Defined in src/core/bindings/Binding.ts:101

Class R2Binding<E>

Example

Author

Version

Since

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns R2Binding<E>

Accessors

name

Returns string

Methods

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<R2ObjectBody>

Throws

getJson

Type Parameters

Parameters

Returns Promise<T>

getText

Parameters

Returns Promise<string>

head

Parameters

Returns Promise<R2Object>

isBound

Parameters

Returns boolean

list

Parameters

Returns Promise<R2Objects>

Remarks

put

Parameters

Returns Promise<R2Object>

putJson

Parameters

Returns Promise<R2Object>

resolve

Parameters

Returns R2Bucket

Throws

tryResolve

Parameters

Returns R2Bucket

Settings

On This Page