zeta-icon-name-checker

An NPM package used to check the validity of icon and category names for the Zeta Icon Library.

Usage

Check Icon Name

Used to check the validity of a single icon name. Pass in categoryName and usedNames to check for duplicate name errors.

checkIconName(
  iconName: string,
  categoryName?: string,
  usedNames?: string[]
): ZetaIconError

Check Category Name

Used to check the validity of a single category name. Only returns an error type of ErrorType.invalidChar or ErrorType.none.

checkCategoryName(categoryName: string): ZetaIconError

Reading Errors

Errors are all of type ZetaIconError. Possible error types are:

enum ErrorType {
  none,
  iconRenamed,
  invalidChar,
  reservedWord,
}

Errors all have severity levels and pre-generated messages based on their type.