util-helpers/types/isIdCard.d.ts

一个基于业务场景的工具方法库

type Options = {
    /**
     * @deprecated 即将废弃。
     */
    loose?: boolean;
    checkCode?: boolean;
};
/**
 * 检测值是否为18位身份证号码。
 *
 * @alias module:Validator.isIdCard
 * @since 1.1.0
 * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码 中华人民共和国公民身份号码}
 * @see {@link https://baike.baidu.com/item/居民身份证号码 居民身份证号码}
 * @param {*} value 要检测的值
 * @param {Object} [options] 配置项
 * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，默认`true`。
 * @returns {boolean} 值是否为身份证号
 * @example
 *
 * isIdCard('130701199310302288'); // true
 * isIdCard('13070119931030228X'); // false
 *
 * // 不校验校验码
 * isIdCard('13070119931030228X', { checkCode: false }); // true
 *
 */
declare function isIdCard(value: any, options?: Options): boolean;
export default isIdCard;