@fallen-zero/use/dist/useEncryptName/index.d.ts

fallen-zero Api

interface EncryptParams {
    start?: number;
    end?: number;
    info?: string;
    char?: string;
}
/**
 * 人名脱敏
 * @author 俞棵
 * @param {string} name 人名
 * @param {object} [options] 参数配置
 * @param {number} [options.start] 开头保留字符数(默认为: 1)
 * @param {number} [options.end] 结尾保留字符数(默认为: 1)
 * @param {string} [options.info] 匹配字符(默认中文字符集)
 * @param {string} [options.char] 替换的字符(默认为: *)
 * @returns {string}
 * @example
 * encryptName('张三', { info: '\u4e00-\u9fa5'})
 * =>
 * '张*'
 */
export declare function encryptName(name: string, { start, end, info, char }?: EncryptParams): string;
/** 托名类型 */
declare const EncryptType: {
    name: {};
    phone: {
        start: number;
        end: number;
        info: string;
        char: string;
    };
    idCard: {
        start: number;
        end: number;
        info: string;
        char: string;
    };
    bankCard: {
        start: number;
        end: number;
        info: string;
        char: string;
    };
    email: {};
};
/**
 * 根据类型进行脱敏
 * @param {keyof typeof EncryptType} type 类型
 * @param {string} str 待脱敏字符串
 * @param {EncryptParams} [options] 配置参数
 * @return {string} 脱敏后的字符串
 */
export declare function encrypt(type: keyof typeof EncryptType, str: string, options?: EncryptParams): string;
export {};