Bucket

Defined in: core/src/bucket/bucket.instance.ts:27

A place to keep file blobs, addressed by /-separated keys. Backed by whatever BucketStorage the container’s bucketCreator produces; the backend is opened on first use and reused thereafter.

Constructors

Constructor

new Bucket(options): Bucket;

Defined in: core/src/bucket/bucket.instance.ts:31

Parameters

Parameter	Type
options	BucketInstanceOptions

Returns

Bucket

Accessors

id

Get Signature

get id(): string;

Defined in: core/src/bucket/bucket.instance.ts:36

The id this bucket was defined with.

Returns

string

Methods

delete()

delete(key): Promise<void>;

Defined in: core/src/bucket/bucket.instance.ts:81

Removes key. Deleting a key that is not there is not an error.

Parameters

Parameter	Type
key	string

Returns

Promise<void>

---

exists()

exists(key): Promise<boolean>;

Defined in: core/src/bucket/bucket.instance.ts:78

Parameters

Parameter	Type
key	string

Returns

Promise<boolean>

---

get()

get(key): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: core/src/bucket/bucket.instance.ts:60

Reads the blob at key; throws BucketObjectNotFoundError if it is missing.

Parameters

Parameter	Type
key	string

Returns

Promise<Uint8Array<ArrayBufferLike>>

---

getText()

getText(key): Promise<string>;

Defined in: core/src/bucket/bucket.instance.ts:70

Reads the blob at key decoded as UTF-8; throws BucketObjectNotFoundError if it is missing.

Parameters

Parameter	Type
key	string

Returns

Promise<string>

---

list()

list(options?): Promise<BucketObject[]>;

Defined in: core/src/bucket/bucket.instance.ts:87

Every object in the bucket, or those under options.prefix, ordered by key.

Parameters

Parameter	Type
options?	BucketListOptions

Returns

Promise<BucketObject[]>

---

put()

put(
   key,
   data,
options?): Promise<BucketObject>;

Defined in: core/src/bucket/bucket.instance.ts:50

Writes data under key, replacing any object already stored there.

Parameters

Parameter	Type
key	string
data	Uint8Array
options?	BucketPutOptions

Returns

Promise<BucketObject>

---

putText()

putText(
   key,
   text,
options?): Promise<BucketObject>;

Defined in: core/src/bucket/bucket.instance.ts:56

Writes text as UTF-8, defaulting the content type to text/plain.

Parameters

Parameter	Type
key	string
text	string
options?	BucketPutOptions

Returns

Promise<BucketObject>

---

stat()

stat(key): Promise<
  | BucketObject
| undefined>;

Defined in: core/src/bucket/bucket.instance.ts:73

Metadata for key, or undefined when nothing is stored there.

Parameters

Parameter	Type
key	string

Returns

Promise< | BucketObject | undefined>