kist/js/actions/SvgSpriteAction/SvgSpriteAction.d.ts

Package Pipeline Processor

import svgSprite from "svg-sprite";
import { Action } from "../../core/pipeline/Action";
import { ActionOptionsType } from "../../types/ActionOptionsType";
/**
 * SvgSpriteAction compiles multiple SVG files into a single sprite sheet,
 * making it more efficient to manage and use SVG assets in web applications.
 */
export declare class SvgSpriteAction extends Action {
    private config;
    /**
     * Default configuration for SVG sprite generation.
     */
    private static defaultConfig;
    /**
     * Constructs an instance with merged default and custom configurations.
     * @param {svgSprite.Config} customConfig - Optional custom configuration
     * for svg-sprite.
     */
    constructor(customConfig?: svgSprite.Config);
    /**
     * Executes the SVG sprite generation process.
     * @param options - Options including source directory and output directory.
     */
    execute(options: ActionOptionsType): Promise<void>;
    /**
     * Generates an SVG sprite from all SVG files in the specified directory.
     * @param sourceDir - Directory containing source SVG files.
     * @param outputDir - Directory where the generated sprite will be saved.
     */
    private generateSprite;
    /**
     * Provides a description of the action.
     * @returns A string description of the action.
     */
    describe(): string;
}
export default SvgSpriteAction;