name.d.mts 1016 B

12345678910111213141516171819202122232425262728293031
  1. /**
  2. * Icon name
  3. */
  4. interface IconifyIconName {
  5. readonly provider: string;
  6. readonly prefix: string;
  7. readonly name: string;
  8. }
  9. /**
  10. * Icon source: icon object without name
  11. */
  12. type IconifyIconSource = Omit<IconifyIconName, 'name'>;
  13. /**
  14. * Expression to test part of icon name.
  15. *
  16. * Used when loading icons from Iconify API due to project naming convension.
  17. * Ignored when using custom icon sets - convension does not apply.
  18. */
  19. declare const matchIconName: RegExp;
  20. /**
  21. * Convert string icon name to IconifyIconName object.
  22. */
  23. declare const stringToIcon: (value: string, validate?: boolean, allowSimpleName?: boolean, provider?: string) => IconifyIconName | null;
  24. /**
  25. * Check if icon is valid.
  26. *
  27. * This function is not part of stringToIcon because validation is not needed for most code.
  28. */
  29. declare const validateIconName: (icon: IconifyIconName | null, allowSimpleName?: boolean) => boolean;
  30. export { type IconifyIconName, type IconifyIconSource, matchIconName, stringToIcon, validateIconName };