Package-level declarations
Types
Options for analyseSVGStructure.
Result of analyseSVGStructure.
API response cache options.
API query parameters.
Result of checking which icons belong to each theme.
Options for SVG cleanup.
Properties shared by icons and aliases.
Options for compareDirectories.
Options for downloadGitHubRepo.
Result of downloadGitHubRepo.
Options for downloadGitLabRepo.
Result of downloadGitLabRepo.
Options for downloadGitRepo.
Result of downloadGitRepo.
Options for downloadNPMPackage.
Result of downloadNPMPackage.
Download source type: "git", "github", "gitlab" or "npm".
Result of running a shell command.
Options for exportIconPackage.
Options for exportJSONPackage.
Options to write custom files during export.
Common options for exporting to a directory.
Options for exportToDirectory.
Icon node from a Figma document.
Options for importFromFigma.
Result of importFromFigma.
Result of parseColors and validateColors.
NPM version information.
GitHub API options.
GitLab API options.
Icon category.
SVG viewBox: left, top, width and height.
Options for importDirectory and importDirectorySync.
NPM package options.
Options for parseColors and validateColors.
Item passed to the parseSVG callback.
Fully resolved icon.
Options for runSVGO.
Properties
Extra options passed to every fetch call, such as proxy settings.
Default concurrency limit (limit: 5) and retry count (retries: 3) for runConcurrentQueries.
Logging callbacks called around API queries: onStart, onSuccess and onError. By default onStart logs the URL.
Functions
Find IDs, links and palette usage in an SVG.
Create a blank icon set with the given prefix.
Bump a version string, for example 1.2.3 to 1.2.4.
Check for tags that should not be in an icon. Throws on failure.
Expand global styles, removing @font-face, @media and similar rules.
Clean up an icon keyword.
Expand inline style attributes.
Clean up the root <style>. Returns removed animations and at-rules.
Clean up an SVG before parsing or optimising it.
Clean up the root <svg> element.
Compare directories, returning true when all files are identical.
Convert CSS rules to attributes using SVGO.
Convert an SVG to a mask, fixing icons that use white where they should be transparent.
Expand compressed paths for software that does not support them.
Detect whether an icon set is monotone (false), palette (true) or mixed (null).
Download a file to target. Throws when the response status is not 200.
Download a GitHub repository using the API.
Download a GitLab repository using the API.
Clone or update a git repository.
Download an npm package. Returns "not_modified" when ifModifiedSince matches.
Download a package from git, GitHub, GitLab or npm, depending on downloadType.
Export an icon set as an @iconify-icons/{prefix} style package.
Export an icon set as an @iconify-json/{prefix} style package.
Export an icon set as one SVG file per icon.
Get the latest commit SHA of a GitHub branch using the API.
Get the latest commit SHA of a GitLab branch using the API.
Get the current branch of a cloned repository, optionally checking out checkout first.
Get the current commit hash (git rev-parse HEAD) of a cloned repository.
Get the version of an npm package from the registry.
Get the version of a package from its package.json, where target is the package directory.
Import all SVG files from a directory.
Synchronous version of importDirectory.
Import an icon set from Figma.
Check if a color is empty, such as none or transparent.
Merge two icon sets. Icons from newIcons take precedence.
Find and optionally replace colors in an SVG.
Find all elements in an SVG and invoke the callback for each element.
Parse CSS in an SVG. Return undefined from the callback to remove a rule.
Normalise and prepare an export directory.
Remove useless attributes from all elements.
Remove the clip path added by Figma and Penpot to icons with overflowing elements.
Reset the contents of a cloned repository, discarding local changes.
Reset the SVG origin to 0 0.
Run asynchronous operations with concurrency and retry limits.
Optimise an SVG with SVGO.
Synchronous version of scanDirectory.
Send an API query and return the response body as text.
Sort theme keys, longest first. Modifies and returns the list.
Validate colors in an SVG. Throws on error.
Write JSON to a file, using tab indentation and a trailing newline.