F

getBucket

Returns the Bucket with the given name. The name is the key the Bucket is saved under on disk.

function getBucket(name?: string): Bucket

Parameters

NameTypeDescription
name?string

The Bucket name. A plugin may omit it to get its own Bucket, named after its id.

Returns

Bucket

The Bucket, with every operation bound to name.

Throws

When name is omitted outside a plugin.