Class SettingsBuilder

Builds a plugin's settings record and applies its saved or default values, namespaced under the plugin's own local storage key.

Index

Constructors

Methods

Constructors

constructor

new SettingsBuilder(): SettingsBuilder
Returns SettingsBuilder

Methods

`Static`buildSettings

buildSettings<T extends SettingsRecord>(
    buildFunc: SettingsBuilderFunction<T>,
    name: string,
    backupName?: string,
    config?: ExtractSettingsConfig<T>,
): T
Type Parameters
- T extends SettingsRecord
Parameters
- buildFunc: SettingsBuilderFunction<T>
- name: string
- OptionalbackupName: string
- config: ExtractSettingsConfig<T> = {}
Returns T
- Defined in packages/viewer/src/core/ViewerSettings.ts:641