Reference
Arcane.preferences.delete()
Deletes one preference; an absent key resolves with deleted:false. Requires preferences.write.
This focused page is derived from the mechanically checked full member inventory.
Syntax
Arcane.preferences.delete(key)
Parameters
key: 1–128-character preference key
Return value
Promise<{key, deleted:boolean, totalBytes, maximumBytes}>
Description
Deletes one preference; an absent key resolves with deleted:false. Requires preferences.write.
Overview
Removes one app-scoped preference so the application can return to its default. An absent key is not an error.
Return value
Requires preferences.write and resolves to
{key,deleted,totalBytes,maximumBytes}. The persisted document changes only
when deleted is true.
Side effects and recovery
Deletion is a serialized atomic preference mutation. If a transport failure
makes the response ambiguous, call get() after reconnecting and branch on
found before retrying. A missing key is already the desired default state and
resolves with deleted:false rather than rejecting.
Example
async function restoreDefaultDensity() {
const result = await Arcane.preferences.delete('layout.density');
return result.deleted;
}
document.querySelector('#restore-default-density')?.addEventListener(
'click',
async function handleRestoreDefaultDensity() {
console.log(await restoreDefaultDensity());
}
);