SettingsAPI
Defined in: namespaces.ts:480
Methods
Section titled “Methods”get(
key):unknown
Defined in: namespaces.ts:482
Gets a plugin setting value.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”unknown
set(
key,value):void
Defined in: namespaces.ts:484
Sets a plugin setting value with full schema validation.
Parameters
Section titled “Parameters”string
unknown
Returns
Section titled “Returns”void
getAll()
Section titled “getAll()”getAll():
Record<string,unknown>
Defined in: namespaces.ts:486
Returns all declared settings with stored values, manifest defaults, or null.
Returns
Section titled “Returns”Record<string, unknown>
onChange()
Section titled “onChange()”onChange(
handler):string
Defined in: namespaces.ts:488
Subscribes to changes on any setting.
Parameters
Section titled “Parameters”handler
Section titled “handler”(key, newValue, oldValue) => void
Returns
Section titled “Returns”string
onKeyChange()
Section titled “onKeyChange()”onKeyChange(
key,handler):string
Defined in: namespaces.ts:490
Subscribes to changes on a specific setting key.
Parameters
Section titled “Parameters”string
handler
Section titled “handler”(newValue, oldValue) => void
Returns
Section titled “Returns”string
offChange()
Section titled “offChange()”offChange(
token):void
Defined in: namespaces.ts:492
Unsubscribes from setting changes.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
openUI()
Section titled “openUI()”openUI():
void
Defined in: namespaces.ts:494
Opens the settings UI for this plugin.
Returns
Section titled “Returns”void