clean-pii
v1.0.0
Published
A robust toolkit for sanitizing sensitive information from text
Maintainers
Readme
TextSanitizer 🛡️
A robust toolkit for sanitizing sensitive information from text:
- PII Redaction (emails, phones, credit cards, etc.)
- Regex Pattern Replacement
- Word List Substitution
- Customizable Sanitization Rules
Installation
npm install TextSanitizer
# or
yarn add TextSanitizerQuick start
import TextSanitizer from 'TextSanitizer';
const config = {
pii: {
enable: true,
patterns: {
email: true, // Use default pattern
phone: '/\\d{3}-?\\d{3}-?\\d{4}/', // Custom pattern
customPiiPatterns: {
employeeId: 'EMP-\\d{5}'
}
}
},
regexReplacements: [
{ pattern: 'secret', replacement: '[REDACTED]', flags: 'gi' }
]
};
const sanitizer = new TextSanitizer(config);
const cleanText = sanitizer.process('Contact me at [email protected] or 555-123-4567');
// "Contact me at [EMAIL_REDACTED] or [PHONE_REDACTED]"Features
🔍 PII Detection & Redaction
- Built-in patterns for common PII:
- Emails
- Phone numbers
- Credit cards
- SSNs
- Custom pattern support
- Configurable placeholder text
✂️ Advanced Text Replacement
- Regex pattern substitution
- Whole word/phrase replacement
- Case-sensitive/insensitive matching
- Multiple replacement passes
⚙️ Flexible Configuration
- JSON config support
- Environment-specific profiles
