Function isValidUserSettings

isValidUserSettings(settings: unknown): settings is UserSettings

Type guard to validate if a value is a valid UserSettings object. Checks for the presence and correct types of all UserSettings properties.

Parameters

settings: unknown
The value to validate

Returns settings is UserSettings

Type predicate indicating if the value is a valid UserSettings object

Example

isValidUserSettings({ showHelp: true, caching: true, currencyRate: 1.0, currency: "USD", location: "US" }) // Returns true
isValidUserSettings({ showHelp: "test", caching: true, currencyRate: 1.0, currency: "USD", location: "US" }) // Returns false

Source

export function isValidUserSettings(settings: unknown): settings is UserSettings {
  const check = getUserSettingsSchema().safeParse(settings);
  if (!check.success) {
    console.warn("isValidUserSettings| The user settings are invalid", {
      settings,
      issues: zodAddActualValueToIssues(check.error.issues, settings),
    });
  }
  return check.success;
}