import type { MaskProps, Stringable } from './mask.class'; import Mask from './mask.class'; /** * Function to use the preconfigured mask */ export declare type MaskApplicator = (target: T) => O; /** * Dataset of the complete mask result */ export declare type CompleteMask = { result: string; completed: boolean; entries: number; cleaned: string; passing: boolean | null; }; /** * Returns a function to use the preconfigured mask. */ export declare function useMask(settings: MaskProps): MaskApplicator; /** * Returns a function to use the preconfigured mask with additional information in the result. */ export declare function useCompleteMask(settings: MaskProps, onComplete?: (result: string, cleaned: string) => boolean): MaskApplicator; /** * Use a mask directly on the target. */ export declare function applyMask(target: T, settingsOrMasks: MaskProps | string | [string, ...string[]]): string; export { getPresetMask, default as presets } from './presets.const'; export type { PresetOption } from './presets.const'; export { Mask }; export type { MaskProps, Stringable };