hkid
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    hkid

    Generate and Validate HKID

    npm version Node.js CI codecov Known Vulnerabilities FOSSA Status

    Installation

    yarn add hkid

    Usage

    import * as hkid from "hkid";

    random()

    generate valid HKID randomly

    console.log(hkid.random()); // H3497811

    validate(candidate: string, option?: { checkPrefix?: boolean})

    validate HKID

    • checkPrefix: check candidate against the known prefix list. If the prefix of candidate is not in the list, consider it as validation failure. (default: false)

      Note: the known prefix list may be incomplete, so false negative may be returned if checkPrefix is set to true.

    console.log(hkid.validate("H3497811")); // true
    console.log(hkid.validate("h3497811")); // true
    console.log(hkid.validate("H349781(1)")); // true
    
    console.log(hkid.validate("H3497810")); // false
    
    console.log(hkid.validate("YK1597716")); // true
    console.log(hkid.validate("YK1597716", { checkPrefix: false})); // true
    console.log(hkid.validate("YK1597716", { checkPrefix: true})); // false

    CodeSandbox

    References

    License

    FOSSA Status

    Keywords

    Install

    npm i hkid

    DownloadsWeekly Downloads

    40

    Version

    1.2.1

    License

    MIT

    Unpacked Size

    7.12 kB

    Total Files

    7

    Last publish

    Collaborators

    • tsekityam