An NPM package used to check the validity of icon and category names for the Zeta Icon Library.
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
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
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.
Zebra Repository Information
- Zebra Business Unit : DMO - I&D Team
- Zebra Manager : mikecoomber
- Zebra Repo Admin: mikecoomber
- Zebra Jira Project ID: N/A
- Product: zeta-icon-name-checker, zeta-icons
- Topics: zeta-icons, icon library