NaNoWriMo Promotes Manuscription
    Have ideas to improve npm?Join in the discussion! »

    ein-validator

    1.0.1 • Public • Published

    ein-validator

    Validate and mask a U.S. Employer Identification Number (EIN).

    Status

    npm version build status

    Installation

    Install the package via npm:

    npm install ein-validator --save

    Usage

    isValid(value)

    This method validates if the given value is a valid Employer Identification Number.

    Arguments

    1. value (*): The value to validate.

    Returns

    (boolean): Returns whether the input value is a valid EIN or not.

    Example

    isValid({});
    // => false
     
    isValid('0112345-67');
    // => false
     
    isValid('01-1234567');
    // => true
     
    isValid('011234567');
    // => true

    mask(value)

    This method will help you protect this sensitive piece of information by obfuscating some digits.

    Arguments

    1. value (*): The value to mask.

    Returns

    (string): Returns the masked value by replacing value certain digits by 'X'.

    Example

    mask({});
    // Throws an Error.
     
    mask('0112345-67');
    // Throws an Error.
     
    mask('01-1234567');
    // => XX-XXX0000
     
    mask('011234567');
    // => XXXXX4567

    Tests

    To test using a local installation of node.js:

    npm test

    To test using Docker exclusively:

    docker-compose run --rm sut

    Release

    npm version [<newversion> | major | minor | patch] -m "Release %s"

    License

    MIT

    Install

    npm i ein-validator

    DownloadsWeekly Downloads

    3,431

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    11.8 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar
    • avatar