Variable BucketType`Const`

BucketType: {
    AllPrivate: "allPrivate";
    AllPublic: "allPublic";
    Restricted: "restricted";
    Snapshot: "snapshot";
} = ...

Named constants for the bucket access level.

The BucketType type alias is derived from the values of this object, so the const is the single source of truth: adding a key here automatically widens the type union.

Type Declaration

ReadonlyAllPrivate: "allPrivate"
Requires a valid auth token to download.
ReadonlyAllPublic: "allPublic"
Publicly downloadable without authentication.
ReadonlyRestricted: "restricted"
B2-restricted bucket (e.g., for S3-compatible workflows).
ReadonlySnapshot: "snapshot"
Internal snapshot bucket type, generally not user-created.

Example

await client.createBucket({ bucketName: 'my-app-logs', bucketType: BucketType.AllPrivate })

Variable BucketType`Const`

Type Declaration

`Readonly`AllPrivate: "allPrivate"

`Readonly`AllPublic: "allPublic"

`Readonly`Restricted: "restricted"

`Readonly`Snapshot: "snapshot"

Example

Settings

Variable BucketTypeConst

Type Declaration

ReadonlyAllPrivate: "allPrivate"

ReadonlyAllPublic: "allPublic"

ReadonlyRestricted: "restricted"

ReadonlySnapshot: "snapshot"

Example

Settings

Variable BucketType`Const`

`Readonly`AllPrivate: "allPrivate"

`Readonly`AllPublic: "allPublic"

`Readonly`Restricted: "restricted"

`Readonly`Snapshot: "snapshot"