Skip to content

BucketOptions

type BucketOptions = {
exposed?: boolean;
id: string;
};

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

Definition of a bucket: its unique id. The definition object doubles as the bucket’s identity — see BucketService.getInstance.

exposed opts the bucket into the host’s HTTP surface, where it answers the same operations it answers internally — list, read, write, delete. It is off by default because a bucket is private implementation detail until someone decides otherwise, and the server applies no per-object access control: an exposed bucket is readable and writable by anyone who can reach the API.

optional exposed?: boolean;

Defined in: core/src/bucket/bucket.types.ts:58


id: string;

Defined in: core/src/bucket/bucket.types.ts:57