Arcane OS Docs Development only

Reference

Arcane.storage.list()

Lists sorted keys and quota use for the current application's isolated native storage. Requires storage.read.

  • Reference

This focused page is derived from the mechanically checked full member inventory.

Syntax

Arcane.storage.list()

Parameters

None

Return value

Promise<{keys:string[], usedBytes:number, maximumBytes:1048576}>

Description

Lists sorted keys and quota use for the current application's isolated native storage. Requires storage.read.

Overview

Reports the keys and quota use for the current application's native storage. Storage is isolated by the application identity bound to the Core session; one application cannot use this namespace to inspect another application's records.

Return value

Requires storage.read and resolves to:

{ keys: string[], usedBytes: number, maximumBytes: 1048576 }

Keys are sorted. usedBytes covers the complete persisted storage envelope, so it can be larger than the sum of the individual JSON values.

Usage and failure behavior

Use the keys to build an index, then call get() only for records the current view needs. An empty array is a valid new-app state. METHOD_NOT_ALLOWED means the current application lacks storage.read; do not fall back to another application's browser storage or retry until policy changes.

Example

async function showStorageBudget() {
    const inventory = await Arcane.storage.list();
    console.log(`${inventory.usedBytes} of ${inventory.maximumBytes} bytes used`);
    for (const key of inventory.keys) console.log(key);
}

await showStorageBudget();

Reference group

Filesystem, storage, preferences, and appearance

Repository and reviewed source access