PreferenceObject: requestOverride() method

{{APIRef("User Preferences API")}}{{SeeCompatTable}}{{SecureContext_Header}}

The requestOverride method of the {{domxref("PreferenceObject")}} interface sets an {{domxref("PreferenceObject.override" "override")}} value for a particular preference.

Syntax

requestOverrides(value)

Parameters

• value
  • : The value to request an override with.

Return value

A {{jsxref("Promise")}} which resolves to {{jsxref("undefined")}} on success, or rejects on failure.

Exceptions

• NotAllowedError {{domxref("DOMException")}}
  • : Thrown if the given value is not allowed.

Examples

Basic usage

The following example requests an override of the {{domxref("PreferenceObject.colorScheme" "colorScheme")}}.

await navigator.preferences.colorScheme.requestOverride("dark");
console.log(navigator.preferences.colorScheme.override);

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}