@sms/objects-r2
Interfaces
R2BucketLike
Defined in: packages/drivers/objects/r2/src/index.ts:27
Methods
delete()
delete(key): Promise<void>;
Defined in: packages/drivers/objects/r2/src/index.ts:35
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<void>
get()
get(key): Promise<R2ObjectBodyLike | null>;
Defined in: packages/drivers/objects/r2/src/index.ts:33
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<R2ObjectBodyLike | null>
head()
head(key): Promise<R2ObjectLike | null>;
Defined in: packages/drivers/objects/r2/src/index.ts:34
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<R2ObjectLike | null>
list()
list(options?): Promise<{
cursor?: string;
delimitedPrefixes: string[];
objects: R2ObjectLike[];
truncated: boolean;
}>;
Defined in: packages/drivers/objects/r2/src/index.ts:36
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<{
cursor?: string;
delimitedPrefixes: string[];
objects: R2ObjectLike[];
truncated: boolean;
}>
put()
put(
key,
value,
options?
): Promise<R2ObjectLike | null>;
Defined in: packages/drivers/objects/r2/src/index.ts:28
Parameters
| Parameter | Type |
|---|---|
key | string |
value | | string | ArrayBuffer | ArrayBufferView<ArrayBufferLike> | ReadableStream<any> |
options? | { customMetadata?: Record<string, string>; httpMetadata?: { contentType?: string; }; } |
options.customMetadata? | Record<string, string> |
options.httpMetadata? | { contentType?: string; } |
options.httpMetadata.contentType? | string |
Returns
Promise<R2ObjectLike | null>
R2ObjectBodyLike
Defined in: packages/drivers/objects/r2/src/index.ts:24
Extends
Properties
body
body: ReadableStream<Uint8Array<ArrayBufferLike>>;
Defined in: packages/drivers/objects/r2/src/index.ts:25
customMetadata?
optional customMetadata?: Record<string, string>;
Defined in: packages/drivers/objects/r2/src/index.ts:22
Inherited from
etag
etag: string;
Defined in: packages/drivers/objects/r2/src/index.ts:19
Inherited from
httpMetadata?
optional httpMetadata?: {
contentType?: string;
};
Defined in: packages/drivers/objects/r2/src/index.ts:21
contentType?
optional contentType?: string;
Inherited from
key
key: string;
Defined in: packages/drivers/objects/r2/src/index.ts:17
Inherited from
size
size: number;
Defined in: packages/drivers/objects/r2/src/index.ts:18
Inherited from
uploaded
uploaded: Date;
Defined in: packages/drivers/objects/r2/src/index.ts:20
Inherited from
R2ObjectLike
Defined in: packages/drivers/objects/r2/src/index.ts:16
Extended by
Properties
customMetadata?
optional customMetadata?: Record<string, string>;
Defined in: packages/drivers/objects/r2/src/index.ts:22
etag
etag: string;
Defined in: packages/drivers/objects/r2/src/index.ts:19
httpMetadata?
optional httpMetadata?: {
contentType?: string;
};
Defined in: packages/drivers/objects/r2/src/index.ts:21
contentType?
optional contentType?: string;
key
key: string;
Defined in: packages/drivers/objects/r2/src/index.ts:17
size
size: number;
Defined in: packages/drivers/objects/r2/src/index.ts:18
uploaded
uploaded: Date;
Defined in: packages/drivers/objects/r2/src/index.ts:20
Functions
createR2ObjectStore()
function createR2ObjectStore(bucket): ObjectStore;
Defined in: packages/drivers/objects/r2/src/index.ts:53
Parameters
| Parameter | Type |
|---|---|
bucket | R2BucketLike |