Skip to main content
Version: 0.17

Interface: BucketSettings

Settings used to instantiate and/or upgrade a Bucket.

Properties​

name​

• Optional name: string

Name used for tracking and debugging a bucket instance.

Defined in​

packages/@orbit/core/src/bucket.ts:10


namespace​

• Optional namespace: string

The namespace used by the bucket when accessing any items.

This is used to distinguish one bucket's contents from another.

Defined in​

packages/@orbit/core/src/bucket.ts:17


version​

• Optional version: number

The current version of the bucket.

Used to identify the version of the bucket's schema and thus migrate it as needed.

Defined in​

packages/@orbit/core/src/bucket.ts:25