Class Redactor

Comprehensive PII and sensitive data redactor.

Redactor

Index

Constructors

constructor

Methods

addPattern exportTokens getAuditTrail getStats importTokens redact redactLogEntry removePattern reset

Constructors

constructor

new Redactor(options?: RedactorOptions): Redactor
Creates a new Redactor instance.
Parameters
- options: RedactorOptions = {}
  Configuration options for the redactor
  
  Redactor configuration options.
  - OptionalauditTrail?: boolean
    Enable audit trail for compliance.
    
    Default
    false
  - OptionalcacheEnabled?: boolean
    Cache redacted values for performance.
    
    Default
    true
  - OptionalcontextAware?: boolean
    Enable context-aware redaction.
    
    Default
    true
  - Optionaldeep?: boolean
    Enable deep object traversal.
    
    Default
    true
  - Optionalenabled?: boolean
    Enable redaction.
    
    Default
    true
  - OptionalexcludeFields?: string[]
    Fields to never redact.
  - Optionalfields?: string[]
    Fields to always redact.
  - OptionalmaxCacheSize?: number
    Maximum cache size.
    
    Default
    1000
  - OptionalmaxDepth?: number
    Maximum traversal depth.
    
    Default
    10
  - Optionalpatterns?: RedactionPattern[]
    Custom redaction patterns.
  - Optionalpreset?: RedactionPreset
    Redaction preset level.
  - OptionaltokenSalt?: string
    Tokenization salt for consistent tokens.
Returns Redactor
- Defined in extensions/Redactor.ts:445

Methods

addPattern

addPattern(pattern: RedactionPattern): void
Add custom redaction pattern.
Parameters
- pattern: RedactionPattern
Returns void
- Defined in extensions/Redactor.ts:847

exportTokens

exportTokens(): Map<string, string>
Export token map for recovery.

Returns Map<string, string>
- Defined in extensions/Redactor.ts:858

getAuditTrail

getAuditTrail(): {
    field?: string;
    original: string;
    pattern: string;
    redacted: string;
    timestamp: Date;
}[]
Get audit trail.

Returns {
    field?: string;
    original: string;
    pattern: string;
    redacted: string;
    timestamp: Date;
}[]
- Defined in extensions/Redactor.ts:830

getStats

getStats(): {
    cacheSize: number;
    fieldRedactions: Map<string, number>;
    patternHits: Map<string, number>;
    tokenCount: number;
    totalRedactions: number;
}
Get redaction statistics.

Returns {
    cacheSize: number;
    fieldRedactions: Map<string, number>;
    patternHits: Map<string, number>;
    tokenCount: number;
    totalRedactions: number;
}
- Defined in extensions/Redactor.ts:815

importTokens

importTokens(tokens: Map<string, string>): void
Import token map for consistency.
Parameters
- tokens: Map<string, string>
Returns void
- Defined in extensions/Redactor.ts:863

redact

redact(data: unknown, fieldPath?: string): unknown
Redact sensitive data from any value.
Parameters
- data: unknown
- fieldPath: string = ''
Returns unknown
- Defined in extensions/Redactor.ts:510

redactLogEntry

redactLogEntry(entry: LogEntry): LogEntry
Redact a LogEntry structure.
Parameters
- entry: LogEntry
Returns LogEntry
- Defined in extensions/Redactor.ts:778

removePattern

removePattern(name: string): void
Remove redaction pattern by name.
Parameters
- name: string
Returns void
- Defined in extensions/Redactor.ts:853

reset

reset(): void
Clear cache and statistics.

Returns void
- Defined in extensions/Redactor.ts:835

Class Redactor

Index

Constructors

Methods

Constructors

constructor

Parameters

OptionalauditTrail?: boolean

Default

OptionalcacheEnabled?: boolean

Default

OptionalcontextAware?: boolean

Default

Optionaldeep?: boolean

Default

Optionalenabled?: boolean

Default

OptionalexcludeFields?: string[]

Optionalfields?: string[]

OptionalmaxCacheSize?: number

Default

OptionalmaxDepth?: number

Default

Optionalpatterns?: RedactionPattern[]

Optionalpreset?: RedactionPreset

OptionaltokenSalt?: string

Returns Redactor

Methods

addPattern

Parameters

Returns void

exportTokens

Returns Map<string, string>

getAuditTrail

Returns { field?: string; original: string; pattern: string; redacted: string; timestamp: Date;}[]

getStats

Returns { cacheSize: number; fieldRedactions: Map<string, number>; patternHits: Map<string, number>; tokenCount: number; totalRedactions: number;}

importTokens

Parameters

Returns void

redact

Parameters

Returns unknown

redactLogEntry

Parameters

Returns LogEntry

removePattern

Parameters

Returns void

reset

Returns void

Settings

On This Page

`Optional`auditTrail?: boolean

`Optional`cacheEnabled?: boolean

`Optional`contextAware?: boolean

`Optional`deep?: boolean

`Optional`enabled?: boolean

`Optional`excludeFields?: string[]

`Optional`fields?: string[]

`Optional`maxCacheSize?: number

`Optional`maxDepth?: number

`Optional`patterns?: RedactionPattern[]

`Optional`preset?: RedactionPreset

`Optional`tokenSalt?: string

Returns {
field?: string;
original: string;
pattern: string;
redacted: string;
timestamp: Date;
}[]

Returns {
cacheSize: number;
fieldRedactions: Map<string, number>;
patternHits: Map<string, number>;
tokenCount: number;
totalRedactions: number;
}