@realfavicongenerator/generate-favicon
Version:
Generate a favicon
26 lines (25 loc) • 1.25 kB
TypeScript
import { Svg } from "@svgdotjs/svg.js";
import { DesktopIconSettings } from "./desktop";
import { TouchIconSettings } from "./ios";
import { WebAppManifestSettings } from "./web-app-manifest";
import { IconTransformation, MasterIcon } from "./helper";
import { ImageAdapter } from "../svg/adapter";
import { FaviconAssetFileNameTransformer, FaviconAssetPathTransformer, FaviconFiles, FaviconMarkups } from "../generation";
export type FaviconIconSettings = {
desktop: DesktopIconSettings;
touch: TouchIconSettings;
webAppManifest: WebAppManifestSettings;
};
export type FaviconSettings = {
icon: FaviconIconSettings;
path: string;
skipMetadataInjection?: boolean;
version?: string;
};
export type EditedIcon = {
icon?: Svg;
transformation: IconTransformation;
};
export declare const initFaviconIconSettings: () => FaviconIconSettings;
export declare const generateFaviconFiles: (masterIcon: MasterIcon, settings: FaviconSettings, imageAdapter: ImageAdapter, pathTransformer?: FaviconAssetPathTransformer, fileNameTransformer?: FaviconAssetFileNameTransformer) => Promise<FaviconFiles>;
export declare const generateFaviconHtml: (settings: FaviconSettings, transformer?: FaviconAssetPathTransformer) => FaviconMarkups;