BucketClient

type BucketClient = {
  delete: (key) => Promise<void>;
  exists: (key) => Promise<boolean>;
  get: (key) => Promise<Uint8Array>;
  getText: (key) => Promise<string>;
  list: (options?) => Promise<BucketObject[]>;
  put: (key, data, options?) => Promise<BucketObject>;
  putText: (key, text, options?) => Promise<BucketObject>;
  stat: (key) => Promise<
     | BucketObject
    | undefined>;
};

Defined in: client/src/buckets/buckets.ts:28

A handle on one exposed bucket, offering the operations the server-side Bucket offers in process. get throws when the object is missing while stat and exists report it by return value — the same split as in core.

Properties

delete

delete: (key) => Promise<void>;

Defined in: client/src/buckets/buckets.ts:36

Parameters

Parameter	Type
key	string

Returns

Promise<void>

---

exists

exists: (key) => Promise<boolean>;

Defined in: client/src/buckets/buckets.ts:35

Parameters

Parameter	Type
key	string

Returns

Promise<boolean>

---

get

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

Defined in: client/src/buckets/buckets.ts:30

Parameters

Parameter	Type
key	string

Returns

Promise<Uint8Array>

---

getText

getText: (key) => Promise<string>;

Defined in: client/src/buckets/buckets.ts:31

Parameters

Parameter	Type
key	string

Returns

Promise<string>

---

list

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

Defined in: client/src/buckets/buckets.ts:29

Parameters

Parameter	Type
options?	BucketListOptions

Returns

Promise<BucketObject[]>

---

put

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

Defined in: client/src/buckets/buckets.ts:32

Parameters

Parameter	Type
key	string
data	Uint8Array
options?	BucketPutOptions

Returns

Promise<BucketObject>

---

putText

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

Defined in: client/src/buckets/buckets.ts:33

Parameters

Parameter	Type
key	string
text	string
options?	BucketPutOptions

Returns

Promise<BucketObject>

---

stat

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

Defined in: client/src/buckets/buckets.ts:34

Parameters

Parameter	Type
key	string

Returns

Promise< | BucketObject | undefined>