@socketsecurity/lib/dist/effects/pulse-frames.d.ts

Core utilities and infrastructure for Socket.dev security tools

/**
 * @fileoverview Socket pulse animation frames generator.
 * Generates themeable pulsing animation frames using sparkles (✧ ✦) and lightning (⚡).
 * Follows the cli-spinners format: https://github.com/sindresorhus/cli-spinners
 */
export type SocketFramesOptions = {
    readonly baseColor?: readonly [number, number, number] | undefined;
    readonly interval?: number | undefined;
    /**
     * Theme to use for pulse colors.
     * Can be a theme name ('socket', 'sunset', etc.) or a Theme object.
     * Note: Currently frames only contain brightness modifiers.
     * Colors are applied by yocto-spinner based on spinner.color.
     */
    readonly theme?: import('../themes/types').Theme | import('../themes/themes').ThemeName | undefined;
};
/**
 * Generate Socket pulse animation frames.
 * Creates a pulsing throbber using Unicode sparkles and lightning symbols.
 * Frames use brightness modifiers (bold/dim) but no embedded colors.
 * Yocto-spinner applies the current spinner color to each frame.
 *
 * Returns a spinner definition compatible with cli-spinners format.
 *
 * @see https://github.com/sindresorhus/cli-spinners/blob/main/spinners.json
 */
export declare function generateSocketSpinnerFrames(options?: SocketFramesOptions | undefined): {
    frames: string[];
    interval: number;
};