README.md

data-scrubber

Data validation and formatting utilities used by Hutson marketing team.

Usage

npm install @hutsoninc/data-scrubber

const {
    scrubEmail,
    scrubHutsonBranch,
    scrubPhone,
    scrubState,
    scrubZip
} = require('@hutsoninc/data-scrubber');

scrubEmail('hello@[email protected]');
// => ''

scrubHutsonBranch('hopkinsville');
// => 'Hopkinsville, KY'

scrubHutsonBranch(1);
// => 'Mayfield, KY'

scrubPhone('(123) 456-7890');
// => '1234567890'

scrubState('kentucky');
// => 'KY'

scrubZip('12345-6789');
// => '12345'

API

Each method will validate and format the input, returning an empty string for invalid inputs or the formatted value otherwise.

scrubEmail

Converts input to lowercase string and returns it.

scrubHutsonBranch

Converts city name or store number to a formatted string.

scrubPhone

Removes formatting (hyphens, parentheses, and spaces), returning a 10-digit phone number string.

scrubState

Converts state names and abbreviations of any case to an all caps abbreviation string.

scrubZip

Removes +4 part from zip codes and returns 5-digit zip code string.

License

MIT © Hutson Inc