Interface: DexieStorageOptions
Defined in: packages/storage-dexie/src/dexie-storage.ts:120
Extends
Partial<OpenOptions>
Properties
atRest?
optional atRest?: "off" | "preferred" | "required";
Defined in: packages/storage/dist/contract.d.ts:172
preferred (default) encrypts when the platform supports it and warns otherwise.
Inherited from
Partial.atRest
blobs?
optional blobs?: "rows";
Defined in: packages/storage-dexie/src/dexie-storage.ts:126
Blob backing store. Only 'rows' (Blob values in the attachments table)
ships today; 'opfs' is the documented escape hatch for hosts that store
video above the 25 MB single-blob cap (docs/09 §4.2) and is not implemented.
broadcast?
optional broadcast?: boolean;
Defined in: packages/storage-dexie/src/dexie-storage.ts:138
Cross-tab change fan-out over BroadcastChannel. Default true.
encryptionKey?
optional encryptionKey?: unknown;
Defined in: packages/storage/dist/contract.d.ts:169
Inherited from
Partial.encryptionKey
gcOnOpen?
optional gcOnOpen?: boolean;
Defined in: packages/storage-dexie/src/dexie-storage.ts:140
Run one gc() pass at open() (docs/09 §4.2). Default false.
indexedDB?
optional indexedDB?: IDBFactory;
Defined in: packages/storage-dexie/src/dexie-storage.ts:144
Injectable engine, for workers and tests.
keyRange?
optional keyRange?: {
(): IDBKeyRange;
prototype: IDBKeyRange;
bound: IDBKeyRange;
lowerBound: IDBKeyRange;
only: IDBKeyRange;
upperBound: IDBKeyRange;
};
Defined in: packages/storage-dexie/src/dexie-storage.ts:146
Must accompany a custom indexedDB; falls back to the global.
Returns
IDBKeyRange
prototype
prototype: IDBKeyRange;
bound()
bound(
lower,
upper,
lowerOpen?,
upperOpen?
): IDBKeyRange;
Returns a new IDBKeyRange spanning from lower to upper. If lowerOpen is true, lower is not included in the range. If upperOpen is true, upper is not included in the range.
Parameters
| Parameter | Type |
|---|---|
lower | any |
upper | any |
lowerOpen? | boolean |
upperOpen? | boolean |
Returns
IDBKeyRange
lowerBound()
lowerBound(lower, open?): IDBKeyRange;
Returns a new IDBKeyRange starting at key with no upper bound. If open is true, key is not included in the range.
Parameters
| Parameter | Type |
|---|---|
lower | any |
open? | boolean |
Returns
IDBKeyRange
only()
only(value): IDBKeyRange;
Returns a new IDBKeyRange spanning only key.
Parameters
| Parameter | Type |
|---|---|
value | any |
Returns
IDBKeyRange
upperBound()
upperBound(upper, open?): IDBKeyRange;
Returns a new IDBKeyRange with no lower bound and ending at key. If open is true, key is not included in the range.
Parameters
| Parameter | Type |
|---|---|
upper | any |
open? | boolean |
Returns
IDBKeyRange
maxBlobBytes?
optional maxBlobBytes?: number;
Defined in: packages/storage-dexie/src/dexie-storage.ts:136
Single-blob ceiling. Default 25 MB — the spine's normative web cap (§7.1).
migrations?
optional migrations?: Migration[];
Defined in: packages/storage/dist/contract.d.ts:170
Inherited from
Partial.migrations
namespace?
optional namespace?: string;
Defined in: packages/storage/dist/contract.d.ts:168
Inherited from
Partial.namespace
now?
optional now?: () => number;
Defined in: packages/storage-dexie/src/dexie-storage.ts:148
Injectable clock, so tests can pin updatedAt/createdAt.
Returns
number
persist?
optional persist?: boolean;
Defined in: packages/storage-dexie/src/dexie-storage.ts:128
Ask for durable storage at open(). Default true.
purgeUploadedBytes?
optional purgeUploadedBytes?: boolean;
Defined in: packages/storage-dexie/src/dexie-storage.ts:142
Free the bytes of uploaded attachments in gc() (rule (b)). Default false.
quotaBytes?
optional quotaBytes?: number;
Defined in: packages/storage-dexie/src/dexie-storage.ts:134
Device quota to assume when the platform has no StorageManager. Also the
ceiling the quota event and the critical-level attachments.put refusal
are computed against, which is what makes both testable off-browser.
warnUnencrypted?
optional warnUnencrypted?: boolean;
Defined in: packages/storage-dexie/src/dexie-storage.ts:150
Emit the unencrypted-storage console warning. Default true.