npm

Check out our latest tech talk, "JavaScript Supply Chain Security" presented by VP of Security, Adam Baldwin.Watch it here »

tin-validator

1.0.0 • Public • Published

tin-validator

Validate and mask a U.S. Taxpayer Identification Number (TIN). A TIN may be an Employer Identification Number (EIN), an Individual Taxpayer Identification Number (ITIN) or a Social Security number (SSN).

Status

npm version build status

Installation

Install the package via npm:

npm install tin-validator --save

Usage

isValid(value)

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

Arguments

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

Returns

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

Example

isValid({});
// => false
 
isValid('9-0-0700000');
// => false
 
isValid('900-70-0000');
// => true
 
isValid('900700000');
// => 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('9-0-0700000');
// Throws an Error.
 
mask('900-70-0000');
// => XXX-XX-0000
 
mask('900700000');
// => XXXXX0000

sanitize(value)

This method will remove all non numeric characters from the value.

Arguments

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

Returns

(string): Returns the sanitized value containing only numeric characters.

Example

sanitize('9-0 0700000');
// => 900700000
 
sanitize('900a7#$0foobar0000');
// => 900700000

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 tin-validator

Downloadsweekly downloads

211

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability