Skip to content

SettingsValidator<PluginSettings, PropertyName>

A validator function for a settings property.

Import:

import type { SettingsValidator } from 'obsidian-dev-utils/obsidian/components/plugin-settings-component';

Signature:

export type SettingsValidator<PluginSettings extends object, PropertyName extends StringKeys<PluginSettings> = StringKeys<PluginSettings>>

Signature:

type SettingsValidator<PluginSettings, PropertyName> = (
value: PluginSettings[PropertyName],
settings: PluginSettings
) => Promisable<MaybeReturn<string>>

Type: ( value: PluginSettings[PropertyName], settings: PluginSettings ) => Promisable<MaybeReturn<string>>