@iconify/utils/lib/icon-set/convert-info.d.ts

Common functions for working with Iconify icon sets used by various packages.

import { IconifyInfo } from '@iconify/types';

/**
 * Item provided by API or loaded from collections.json, slightly different from IconifyInfo
 */
interface LegacyIconifyInfo {
    name: string;
    total?: number;
    version?: string;
    author?: string;
    url?: string;
    license?: string;
    licenseURL?: string;
    licenseSPDX?: string;
    samples?: string[];
    height?: number | number[];
    displayHeight?: number;
    samplesHeight?: number;
    category?: string;
    palette?: 'Colorless' | 'Colorful';
    hidden?: boolean;
}
/**
 * Convert data to valid CollectionInfo
 */
declare function convertIconSetInfo(data: unknown, expectedPrefix?: string): IconifyInfo | null;

export { type LegacyIconifyInfo, convertIconSetInfo };