Installation
npm install -S lib-redactor
Usage
import redactor from "lib-redactor";
const redactMe = {
first_name: "John",
last_name: "Doe",
phone_number: "6969696969",
email: "john.doe69@email.com"
};
const redactionRule = redactor(["phone_number", "email"]);
const redacted = redactionRule(redactMe);
console.log(redacted);
Changing mask character
import redactor from "lib-redactor";
const redactMe = {
first_name: "John",
last_name: "Doe",
phone_number: "6969696969",
email: "john.doe69@email.com"
};
const options = {
maskCharacter: "X"
};
const redactionRule = redactor(["phone_number", "email"], options);
const redacted = redactionRule(redactMe);
console.log(redacted);
Redacting based on supplied keywords or basic pattern
import redactor from "lib-redactor";
const redactMe = {
phrase: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
}
;
const options = {
maskCharacter: "X",
fullRedaction: true,
blacklistedWords: [
/Lorem/g,
"elit",
"non",
"dolor"
]
};
const redactionRule = redactor([], options);
const redacted = redactionRule(redactMe);
console.log(redacted);
License
lib-redactor is WTFPL licensed.