Interface SanitizeOptions

interface SanitizeOptions {
    escapeHtml?: boolean;
    normalizeWhitespace?: boolean;
    redactPII?: boolean | RedactOptions;
    trim?: boolean;
}

Properties

escapeHtml?: boolean

Escape the five HTML special characters via escapeHtml. Always the last step, regardless of option order -- see below.

normalizeWhitespace?: boolean

Collapse internal whitespace runs to a single space (also trims the ends -- see normalizeWhitespace).

redactPII?: boolean | RedactOptions

Redact PII/secrets via redact. true uses redact's own defaults; pass an options object to control its types/maskChar.

trim?: boolean

Trim leading/trailing whitespace.