Skip to main content

Type Alias: MaskingTerms

MaskingTerms = string[] | { replace: string[]; }

Defined in: core/masking-terms.ts:20

How a configured list of sensitive names relates to the built-in one.

An array adds: the built-in list stays and these join it. That is what every masking option here has always effectively done — the collector masks every payload on its way to storage with its own defaults, so a shorter list configured on a watcher never actually narrowed anything.

{ replace: [...] } is the way to say the other thing, and it has to be said out loud. It drops the built-in list entirely and masks exactly what is named, which is the right answer when the defaults redact a field this application needs to read — and the wrong answer by accident, which is why it is not what a bare array means.

sensitiveParams: ['iban'] // the defaults, plus iban
sensitiveParams: { replace: ['iban'] } // iban, and nothing else