Function useSettings

Safe, simple, and centralized setting state management

useSettings() lets you avoid code duplication, boilerplate, and unnecessary use of the async onload() anti-pattern, while also allowing settings management to be divided among multiple components.

Just give it a callback that will be invoked with new settings values (including when the settings initially load), and you get back a SettingsService whose update() method you can call to update the settings. No need to touch loadData or saveData, or to duplicate code between your settings tab and your onload (not to mention any settings-changing commands!).

Instead, your settings tab (and/or commands) can just call .update() to update the state, and the changes will be saved and propagated automatically. You can also split your settings into parts managed by different services (as with useSettingsTab), so you don't end up with a giant blob of code for settings application.

Example:

type MySettings = {...};

class MyPlugin extends Plugin {
    settings = useSettings<MySettings>(
        this,   // plugin or other owner
        {...},  // default settings
        (settings) => {
            // code that runs when settings are loaded or changed
        },
        (settings) => {
            // code to do one-time setup only
        }
    )
}
Copy