obsidian-dev-utils/dist/lib/cjs/obsidian/Plugin/PluginSettingsWrapper.d.cts

This is the collection of useful functions that you can use for your Obsidian plugin development

/**
 * @packageDocumentation
 *
 * Plugin settings wrapper.
 */
import type { StringKeys } from '../../Type.cjs';
/**
 * A wrapper for plugin settings.
 *
 * @typeParam PluginSettings - The type of the plugin settings.
 */
export interface PluginSettingsWrapper<PluginSettings extends object> {
    /**
     * Safe settings.
     */
    safeSettings: PluginSettings;
    /**
     * Possibly unsafe settings.
     */
    settings: PluginSettings;
    /**
     * A validation messages.
     */
    validationMessages: Record<StringKeys<PluginSettings>, string>;
}