@code-ts/cin/dist/index.d.ts

Utils about citizen identification number | 公民身份证号码工具方法

interface ParseResult {
    isValid: boolean;
}

/**
 * parse cin
 * @param code code to parse
 * @returns parsed result `ParseResult`
 *
 * @example
 * ```
 * import { parseCIN } from '@code-ts/cin'
 * parseCIN('110101199003076878') // { isValid: true }
 * ```
 */
declare function parseCIN(code: string): ParseResult;

/**
 * 校验公民身份证号码
 * @param code 公民身份证号码
 * @returns 是否有效
 *
 * @example
 * ```
 * import { validateCIN } from '@code-ts/cin'
 * validateCIN('110101199003076878')  // true
 * ```
 */
declare function validateCIN(code: string): boolean;

/**
 * 身份证号码正则
 *
 * @see https://regexper.com/#%2F%5E%5B1-9%5D%5Cd%7B5%7D%2818%7C19%7C%28%5B23%5D%5Cd%29%29%5Cd%7B2%7D%28%280%5B1-9%5D%29%7C%2810%7C11%7C12%29%29%28%28%5B0-2%5D%5B1-9%5D%29%7C10%7C20%7C30%7C31%29%5Cd%7B3%7D%5B%5Cdx%5D%24%2Fi
 */
declare const CIN_PATTERN: RegExp;

export { CIN_PATTERN, type ParseResult, parseCIN, validateCIN };