Skip to content

quicklyValidateIconSet()

此函数属于 Iconify Utils 包

函数 quicklyValidateIconSet() 用于验证图标集,并返回清理后的 IconifyJSON 对象。

如果提供的数据存在错误,它将返回 null

此函数不会检查元数据。

用法

该函数包含以下参数:

  • dataobject。需要验证的数据。

函数返回值:

  • 成功时返回 IconifyJSON 对象(与传入的第一个参数相同)。
  • 出错时返回 null

示例

usage.ts
tsimport { promises as fs } from 'fs';
import { quicklyValidateIconSet } from '@iconify/utils';

(async () => {
   // Load data from file
   const data = JSON.parse(
       await fs.readFile(
           './node_modules/@iconify-json/mdi-light/icons.json',
           'utf8'
       )
   );

   // Validate data
   const iconSet = quicklyValidateIconSet(data);
   if (!iconSet) {
       console.error('Bad icon set');
       return;
   }

   // Count icons (simple calculation)
   const count =
       Object.keys(iconSet.icons).length +
       (iconSet.aliases ? Object.keys(iconSet.aliases).length : 0);
   console.log(`Found ${count} icons`);
})();

高级验证

此函数针对包体积和性能进行了优化,因此仅执行基本验证。

如果您想完全验证图标集,请改用 validateIconSet()