Arcane OS Docs Development only

Reference

Arcane.preferences.list()

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

  • Reference

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

Syntax

Arcane.preferences.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 preferences. Requires preferences.read.

Overview

Reports the current application's preference keys and quota use. Preferences share the storage value and key validation rules but live in a separate app-scoped preferences document.

Return value

Requires preferences.read and resolves to {keys,usedBytes,maximumBytes}. Keys are sorted and maximumBytes is currently 1,048,576 bytes for the complete preferences envelope.

Usage and failure behavior

Use this inventory to discover configured names, then read a needed preference with get(). Apply an application default only when that result says found:false. An empty list is valid. METHOD_NOT_ALLOWED means the application lacks preferences.read; do not switch to an unreviewed persistence path.

Example

async function listPreferenceNames() {
    const inventory = await Arcane.preferences.list();
    return inventory.keys;
}

console.log(await listPreferenceNames());

Reference group

Filesystem, storage, preferences, and appearance

Repository and reviewed source access