Type Alias SettingsPluginConfig

Type declaration

• Optionalpersist?: boolean

  should the settings be saved accross sessions

  Default

  false
  Copy

• Optionalstorage?: {
      get(
          settingId: string,
      ): string | boolean | Promise<boolean> | Promise<string>;
      set(settingId: string, value: string | boolean): void;
  }

  custom storage handler, defaults to LocalStorage

  Default

  LocalStorage
  Copy

  • get:function

    • get(settingId: string): string | boolean | Promise<boolean> | Promise<string>

    • return undefined or null if the option does not exist

      Parameters

      • settingId: string

      Returns string | boolean | Promise<boolean> | Promise<string>

  • set:function

    • set(settingId: string, value: string | boolean): void

    • Parameters

      • settingId: string
      • value: string | boolean

      Returns void