TypeScript API / laikacms/storage/s3 / R2BucketLike

Interface: R2BucketLike

The 5-method subset of R2Bucket that R2StorageRepository uses.

Methods

delete()

delete(key): Promise<void>;

Parameters

Parameter	Type
key	string

Returns

Promise<void>

---

get()

get(key): Promise<R2ObjectBody | null>;

Parameters

Parameter	Type
key	string

Returns

Promise<R2ObjectBody | null>

---

head()

head(key): Promise<R2Object | null>;

Parameters

Parameter	Type
key	string

Returns

Promise<R2Object | null>

---

list()

list(options): Promise<R2ListResult>;

Parameters

Parameter	Type
options	{ cursor?: string; delimiter?: string; limit?: number; prefix?: string; }
options.cursor?	string
options.delimiter?	string
options.limit?	number
options.prefix?	string

Returns

Promise<R2ListResult>

---

put()

put(
   key, 
   value, 
   options?
): Promise<R2Object>;

Parameters

Parameter	Type
key	string
value	string | ReadableStream<any> | Uint8Array<ArrayBufferLike>
options?	{ httpMetadata?: { contentType?: string; }; }
options.httpMetadata?	{ contentType?: string; }
options.httpMetadata.contentType?	string

Returns

Promise<R2Object>