Introduction

This module is extremely simple and attempts to do nothing more than one task. It has no dependencies unless you're testing it.

It was developed for the sole purpose of anonymizing data so that it can securely be transmitted to third party services such as analytics platforms.

To install it, use npm install simple-data-anonymizer

Usage

The only function available accepts three arguments: stringAnonymizer(string_to_be_anonymized, beginning, end)

The beginning and end arguments define where the anonymizer should leave data visible.

beginning and end arguments are absolute. The particular implication here is that for end if you wish to keep only the last 4 characters you should supply -4

Simple Usage

var stringAnonymizer = require('simple-data-anonymizer').string;

stringAnonymizer('[email protected]', 2, '@'); // returns fo********@emailservice.com
stringAnonymizer('[email protected]', '@', -4); // returns foobaruser@************.com
stringAnonymizer('[email protected]', 4, -4); // returns foob*******************.com

More Advanced usage

The anonymizer accepts an array of values to iterate over so that it can find a matching string. It chooses the position identifier by order of the array:

stringAnonymizer('[email protected]', ['-', 'bar', 2], '@'); // returns foobar****@emailservice.com
stringAnonymizer('[email protected]', ['s', 'bar', 2], ['mail', '.', -4]); // returns foobarus****mailservice
.com

The anonymizer will use the first occurrence of the character for the beginning position and the last occurrence for the end position. For example:

var string = 'abc.abc.abc.abc';

stringAnonymizer(string, 3, '.');   // returns abc********.abc
stringAnonymizer(string, '.', '.'); // returns abc.*******.abc
stringAnonymizer(string, '.', -3);  // returns abc.********abc

The begininng and end arguments are capable of receiving an ordered list to look through.