gome-id-card v1.0.3

gome-id-card

这是一个国美内部保险项目使用到的工具包

install

npm i gome-id-card --save

how to work

import {GomeIdCard} from "gome-id-card";

// 参数可有可不。都有默认值
const idcard = new GomeIdCard({
    idCardStr: "你的身份证号，默认随机",
    splitStr: "初始化 string 分隔符， 默认'-'"
    teenage: "低于该年龄为青少年，默认 18",
    older: "超出该年龄为老人，默认 60",
    mastOverDate: "危险期"
});

interface

interface GomeIdCard {
    static _parseIdCard;    // 静态解析器（可解析身份证信息）
    static makeIdCard;      // 静态身份证生成器 （可随机生成身份证【用于测试】）
    static isIdCardValid(idCardStr);   // 静态身份证合法校验器（可校验身份证合法性）
    static getIdCardInfo;               // 静态获取身份证信息获取器（可解析身份证所有信息，包括但不限于地名，出生等）
    isIdCardValid;          // 自身合法信息
    getIdCardInfo           // 自身解析的信息
    idCardStr               // 自身身份证号
    birthDate               // 自身出生日期（Date 格式）
    birthStr                // 自身出生日期（String 格式）
    option: OptionInterface;
    // 是否出生超过30天 now 为参照日期，默认今天
    isMastOverDate(now = new Date()): boolean;
    // 是否是青年人 再青少年跟老人之间为青年
    isYoung(now = new Date()): boolean;
    // 是否是老年人
    isOlder(now = new Date()): boolean;
    // 是否是青少年
    isTeenage(now = new Date()): boolean;
    /**
     * 增加日期 option 可选 {y: number, m: number, d: number}
     * 如：在 2018年4月3日往前推5天
     * addDate(new Date(2018,4,3), {d: -5});
     * 在 2018年4月3日往前推一年
     * addDate(new Date(2018,4,3), {y: -1});
     * 在 2018年4月3日往前推3月
     * addDate(new Date(2018,4,3), {m: -3});
     * */
    addDate(date: Date | any = new Date(), option = {}): Date;
    // 解析字符串为日期 默认返回当前对象的出生
    dateParse(dateStr: string | any = this.birthStr, splitStr = this.option.splitStr): Date
    // 解析日期为字符串 默认返回当前时间的格式化
    dateFormat(date: Date = new Date(), fmt = 'yyyy-MM-dd hh:mm:ss'): string;
    // 获取年龄 如：12.5 小数部分为当前已过时间除以当年所有时间所占比 保留4位有效小数 默认返回当前对象的岁数
    getAgeFromDate(now = new Date()): number;
    // 获取两个日期之间一共有多少天 默认返回一年的天数
    getDayBetweenDate(date1: Date = this.addDate(new Date(), { y: -1 }), date2: Date = new Date()): number;
    // 获取闰年或者平年的所有天数 闰年：366 平年： 365 默认返回今年所有天数
    getDayFullYear(year = new Date().getFullYear()): number;
}

EDN