parse-ssn
Tiny toolkit to format, mask, and validate US Social Security numbers.
npm i parse-ssn --save
Usage
mask(value: string[, placeholder = '*']): string
import { mask } from "parse-ssn";
format("123121234");
format("123121234", "#");
format(value: string[, separator = '-', existingPlaceholder = '*']): string
import { format } from "parse-ssn";
format("123121234");
format("123121234", " ");
Compose methods for additional flexibility:
import { format, mask } from "parse-ssn";
const masked = mask("123121234");
const formatted = format(masked);
When dealing with formatting of masks that use a placeholder other than *
, you
need to pass additional information about the format.
import { format } from "parse-ssn";
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.
import { validate } from "parse-ssn";
validate("123121234");
clean(value: string, exception = ''): string
By default, clean
strips out all characters except numbers, and trims the
string to nine characters.
import { clean } from "parse-ssn";
clean("123-12-1234")
clean(" 123 12-1234")
clean("123-12-1234-12345")
To clean a string that may be masked, pass an exception.
import { clean } from "parse-ssn";
clean("*****1234", "*")
License
MIT License © Truework