parse-ssn
Tiny toolkit to format, mask, and validate US Social Security numbers.
npm i parse-ssn
Usage
mask(value: string[, placeholder = '*']): string
// => *****1234 // => #####1234
format(value: string[, separator = '-', existingPlaceholder = '*']): string
// => 123-12-1234 // => 123 12 1234
Compose methods for additional flexibility:
const masked = // => *****1234const formatted = // => ***-**-1234
When dealing with formatting of masks that use an existing placeholder other
than *
, you need to pass additional information about the format.
// => ###-##-1234
validate(value: string): boolean
Validation is based on information gathered from the Social Security Administration's website. If an edge case is missing, please open an issue.
// => true
clean(value: string, exception = ''): string
By default, clean
strips out all characters except numbers, and trims the
string to nine characters. You probably want to use this first before mask
or
format
.
// => 123121234 // => 123121234 // => 123121234
To clean a string that may be masked, pass an exception.
// => *****1234
License
MIT License © Truework