/** * 身份证信息接口 */ export interface IdCardInfo { /** 省份 */ province: string; /** 城市 */ city: string; /** 区县 */ area: string; /** 出生日期 */ birthday: string; /** 性别:M-男,F-女 */ gender: 'M' | 'F'; /** 年龄 */ age: number; /** 星座 */ constellation: string; /** 生肖(基于出生年份计算) */ zodiac: string; } /** * 生成身份证配置选项(基于idcard库的实际API) */ export interface GenerateIdCardOptions { /** 地区代码 */ areaCode?: string; /** 出生日期,格式:YYYY-MM-DD */ birthday?: string; /** 派出所代码 */ localPolice?: string; /** 性别:Number类型,1-男,0-女 */ gener?: Number; } /** * 操作结果接口 */ export interface IdCardResult { /** 是否成功 */ success: boolean; /** 结果数据 */ data?: T; /** 错误信息 */ error?: string; } /** * 验证身份证号码格式和有效性 * @param idCardNumber 身份证号码 * @returns 验证结果,包含成功状态和错误信息 * * @example * ```typescript * const result = validateIdCard('110101199003070134'); * if (result.success) { * console.log('身份证号码有效'); * } else { * console.log('验证失败:', result.error); * } * ``` */ export declare const validateIdCard: (idCardNumber: string) => IdCardResult; /** * 生成随机身份证号码 * @param options 生成配置选项 * @returns 生成结果,包含身份证号码或错误信息 * * @example * ```typescript * // 生成随机身份证 * const result1 = generateIdCard(); * * // 生成指定性别的身份证 * const result2 = generateIdCard({ gener: 1 }); * * // 生成指定出生日期的身份证 * const result3 = generateIdCard({ birthday: '1990-01-01' }); * * // 生成指定地区的身份证 * const result4 = generateIdCard({ areaCode: '110101' }); * ``` */ export declare const generateIdCard: (options?: GenerateIdCardOptions) => IdCardResult; /** * 解析身份证号码,获取详细信息 * @param idCardNumber 身份证号码 * @returns 解析结果,包含身份证详细信息或错误信息 * * @example * ```typescript * const result = parseIdCard('110101199003070134'); * if (result.success && result.data) { * console.log('省份:', result.data.province); * console.log('出生日期:', result.data.birthday); * console.log('性别:', result.data.gender === 'M' ? '男' : '女'); * } * ``` */ export declare const parseIdCard: (idCardNumber: string) => IdCardResult; /** * 获取身份证号码对应的年龄 * @param idCardNumber 身份证号码 * @returns 年龄计算结果 * * @example * ```typescript * const result = getIdCardAge('110101199003070134'); * if (result.success) { * console.log('年龄:', result.data); * } * ``` */ export declare const getIdCardAge: (idCardNumber: string) => IdCardResult; /** * 获取身份证性别 * @param idCardNumber 身份证号码 * @returns 性别信息(M-男,F-女) * * @example * ```typescript * const result = getIdCardGender('110101199003070134'); * if (result.success) { * console.log('性别:', result.data === 'M' ? '男' : '女'); * } * ``` */ export declare const getIdCardGender: (idCardNumber: string) => IdCardResult<"M" | "F">; /** * 获取身份证出生地区信息 * @param idCardNumber 身份证号码 * @returns 地区信息 * * @example * ```typescript * const result = getIdCardRegion('110101199003070134'); * if (result.success) { * console.log('地区:', `${result.data.province} ${result.data.city} ${result.data.area}`); * } * ``` */ export declare const getIdCardRegion: (idCardNumber: string) => IdCardResult<{ province: string; city: string; area: string; }>;