@philiprehberger/ts-mask-kit

Data masking and redaction for logs and APIs.

Installation

npm install @philiprehberger/ts-mask-kit

Usage

import { maskEmail, maskCreditCard, maskObject } from '@philiprehberger/ts-mask-kit';

maskEmail('[email protected]');     // "u***@e******.com"
maskCreditCard('4111111111111111'); // "************1111"

const safe = maskObject(requestBody, {
  rules: ['password', 'secret', /token/i, 'creditCard'],
});
logger.info('Request', safe);

API

| Function | Description | |----------|-------------| | maskEmail(email) | Mask email preserving structure | | maskCreditCard(card) | Show last 4 digits | | maskPhone(phone) | Show last 3 digits | | maskToken(token) | Show first/last 4 chars | | maskIP(ip) | Mask middle octets | | maskCustom(str, options?) | Custom masking with position control | | maskObject(obj, { rules }) | Deep-walk and mask matching keys | | detectType(value) | Auto-detect value type |

Development

npm install
npm run build
npm test

License

MIT