Interface: RedactConfig
Defined in: packages/core/src/presenter/RedactEngine.ts:47
Configuration for PII redaction.
Example
typescript
const config: RedactConfig = {
paths: ['*.ssn', 'credit_card.number', 'patients[*].diagnosis'],
censor: '[REDACTED]',
};Properties
censor?
ts
readonly optional censor: string | (value) => string;Defined in: packages/core/src/presenter/RedactEngine.ts:70
Replacement value for redacted fields.
- String: Static replacement (default:
'[REDACTED]') - Function: Dynamic censor
(originalValue) => maskedValue(e.g.(v) => '***' + String(v).slice(-4))
Default
ts
'[REDACTED]'paths
ts
readonly paths: readonly string[];Defined in: packages/core/src/presenter/RedactEngine.ts:59
Array of object paths to redact, using fast-redact syntax.
Supports:
- Dot notation:
'user.ssn' - Bracket notation:
'user["ssn"]' - Wildcards:
'*.ssn','patients[*].diagnosis' - Array indices:
'items[0].secret'
See
https://github.com/davidmarkclements/fast-redact#paths--array