Files
plexjs/docs/models/shared/setting.md

5.2 KiB
Raw Permalink Blame History

Setting

A configuration setting or preference

Example Usage

import { Setting } from "@lukehagar/plexjs/models/shared";

let value: Setting = {};

Fields

Field Type Required Description
type shared.SettingType The type of the value of this setting
default shared.Default The default value of this setting
advanced boolean Whether the setting is considered advanced and normally hidden from the user
enumValues string The possible values for this setting if restricted. The list is | separated with value:name entries.
group string The group name of this setting to aid in display of a hierarchy
hidden boolean Whether the setting is hidden or not
id string The query parameter name for this setting
label string A user-friendly name for the setting
summary string A description of the setting
value shared.Value The current value of this setting