brazilian-values/types/formatters/formatToHiddenDigits.d.ts

Validates and formats brazilian values, like money (BRL), CPF, CNPJ, dates etc.

/** Options object for {@link formatToHiddenDigits} function. */
export declare type FormatToHiddenDigitsOptions = {
    /**
     * The range of digits replaced by {@link FormatToHiddenDigitsOptions.hider}
     * character. It can be both a tuple of numbers or a single number.
     *
     * @example ```js
     * formatToHiddenDigits("00.000-00", { range: 2 });
     * //=> "**.000-00"
     *
     * formatToHiddenDigits("00.000-00", { range: -2 });
     * //=> "00.000-**"
     *
     * formatToHiddenDigits("00.000-00", { range: [1, 4] });
     * //=> "0*.***-00"
     * ```
     *
     * @default 3
     */
    range?: number | [number, number];
    /**
     * The character used as replacement for digits in within
     * {@link FormatToHiddenDigitsOptions.range}.
     *
     * @example ```js
     * formatToHiddenDigits("00.000-00", { hider: "-" });
     * //=> "--.-00-00"
     *
     * formatToHiddenDigits("00.000-00", { hider: " " });
     * //=> "  . 00-00"
     *
     * formatToHiddenDigits("00.000-00", { hider: "#" });
     * //=> "##.#00-00"
     * ```js
     *
     * @default "*"
     */
    hider?: string;
};
/**
 * Formats a `string` value with digits by replacing the digits within the
 * range using the hider character as replacement.
 *
 * @example ```js
 * formatToHiddenDigits('00.000-000')
 * //=> '**.*00-000'
 *
 * formatToHiddenDigits('03/04/2002', { hider: '-' })
 * //=> '--/-4/2002'
 *
 * formatToHiddenDigits('111.111.111-11', { range: [4, 9] })
 * //=> '111.***.***-11'
 *
 * formatToHiddenDigits('12.345.678-9', { hider: '#', range: 5 })
 * //=> '##.###.678-9'
 *
 * formatToHiddenDigits('52.715.348/0001-69', { hider: '@', range: -9 })
 * //=> '52.715.@@@/@@@@-@@'
 * ```
 *
 * @param value - A `string` with digits, with or without a mask.
 * @param options - The options object.
 */
declare const formatToHiddenDigits: (value: string, options?: FormatToHiddenDigitsOptions) => string;
export default formatToHiddenDigits;